Interoperable browser chat based on OpenOdin

Usage

Step out from the platform: Enter The Void

Firefox

1. Download the Datawallet extension from https://addons.mozilla.org/en-US/firefox/addon/datawallet/. Direct download link: https://addons.mozilla.org/firefox/downloads/file/4346369/datawallet-0.4.1.xpi

2. Confirm the addition of the new extension by clicking the Add button

3. Access the Extensions by typing about:addons on the address bar or by clicking the puzzle icon

4. Then click Extensions on the left side menu

5. Customize your preferences: toggle the extension on and off, Run in Private Windows (incognito mode) if you wish to do so.

6. Make it easy to access the extension by clicking the puzzle icon, then the Gear icon right next to Datawallet, and select Pin to Toolbar

7. The Datawallet icon will now show in the browser toolbar. Click on it and follow the on-screen instructions: click the wallet icon to acess the list of wallets

8. Press the New Wallet button

9. Enter the Wallet Name and Password, then press Create

10. Now back to the wallet list, edit the newly created wallet by clicking the button highlighted on the screenshot below

11. Next, there will be no keys attached to the newly created wallet. Create a new key pair by pressing the New button

12. The key pair will now be listed as part of the wallet. Press the Save button

13. Browse to https://openodin.com/webchat then Press the Datawallet extension icon

14. Press the Authenticate button

15. Enter the Password then press Unlock

16. Proceed with the one-time signing confirmation by pressing the OK button

17. All done, you are set!

18. Have fun!

Configuration files

For development builds the .json files are copied from ./conf-dev into the root directory of the app which is built into ./dist.

For release builds the appropiate conf file(s) must be place in ./dist by the outer release process.

The default JSON file loaded by the application is app.json, to use any other file load the app using the conf query parameter, as: IP:8000/index.html?conf=my-conf.json.

After building you are free to replace the configuration files in the ./dist dir as configuration files are dynamically fetched when the application is authenticated with the Datawallet.

Datawallet browser plugin

To use this webchat you need the OpenOdin Datawallet browser plugin.

Build and run

npm i
npm run build
./serve.sh

The application files are placed in ./dist.

Browse to <IP:8000>/index.html.

Release

npm i
npm run release

The application files are placed in ./dist.

Place an applicable app.json file into ./dist and the application is ready for release.

If using a prebuilt release make sure to add the app.json into the root dir of the app when publishing it.

Tags are inspired by the SemVer.org convention. The version is expected to match the following regular expression:

[0-9]+.[0-9]+.[0-9]+

Create a new tag from GitHub so that the artifacts get automatically built by GitHub Action.
To do so, draft a new release here: https://github.com/OpenOdin/webchat/releases/new.