A project by the HOPR Association
MyneChat is a fully private, data and metadata secure chat. Powered by the HOPR network, with MyneChat no-one can find out your business or who you’re communicating with.
The easiest way to launch MyneChat and setup a cluster of HOPR nodes to start testing it is via Gitpod.io. It will automatically fetch and install all the required dependencies and spin up the needed services for you to start tweaking MyneChat.
MyneChat requires the following:
node.js@v16
yarn
First, we need to set up MyneChat in our workstation:
git clone https://github.com/hoprnet/myne-chat
cd myne-chat
yarn # install libraries
To run the development server:
yarn dev # run development server
Open http://localhost:8080 with your browser to see the result.
To run MyneChat's production version:
yarn build # build website
yarn start # run a hosting server
Open http://localhost:8080 with your browser to see the result.
To deploy MyneChat, you need to build it and then upload it to any static hosting site. MyneChat is currently deployed in Vercel
To use most of its feature, MyneChat comes with a mock server which simulates a HOPRd node:
yarn mocks
Single http endpoint become available which match the default HOPRd endpoint:
API=http://localhost:3001
To connect a MyneChat instance to a HOPR node, you need to be aware of the following:
v1.85.0
to work properly with MyneChat.Admin URL
(--adminHost
in hoprd
and Admin URL
in the setup script).For more information on how to run a local node, see hopr documentation. To fully test MyneChat using HOPR nodes, you need to set up a local HOPR node cluster (needed to fully use MyneChat locally, see the local cluster setup instructions).
To test MyneChat against production HOPR nodes, checkout the tutorial. Be aware that for this to work, your HOPR node will need to have wxHOPR
tokens from the Gnosis Chain network and have a few channels open. Additionally, you will need to know the PeerId
of the HOPR node you want to talk to.
In order to run MyneChat, a user has to setup MyneChat locally.
This tutorial shows how to set up MyneChat and a hoprd
node locally.
hoprd
node (at least v1.85.0). Multiple ways to do this are described in the hoprd documentation. For simplicity, use Docker and spin up a node locally using the lisbon
release:docker run --pull always -p 3000:3000 -p 3001:3001 gcr.io/hoprassociation/hoprd:lisbon --apiToken ^MYtoken4testing^ --password hodlerATWORK --api --admin --init
To be able to use the node you must fund it with native (xDAI) and HOPR tokens.
yarn
yarn dev
As a result you may now navigate to http://localhost:8080/ and view the MyneChat UI.
Now the local hoprd
node can be configured as the endpoint within your MyneChat UI. Click on the settings icon in the top left corner and enter the following details:
Important: Your API token might vary, which means it might have unsupported parameters as query parameters (e.g, %
, +
). Because we are passing the API token as query string, your token might need to be URIEncoded
for it to work. To be safe, please make sure it's properly encoded before pasting the API token into the UI. This will be improved in future versions of MyneChat.
hoprd
node. The MyneChat logo will turn white once it has successfully connected.Now MyneChat and hoprd
are set up.
For each chat you will need to open a channel to the given peer through the hoprd
admin UI. Then you may start a chat within MyneChat itself.
To learn more about HOPR, take a look at the following resources: