Chatterbox

Chatterbox lets you securely embed Hydrogen within any website.

Develop Instructions

---

1. Clone the repo.
2. Install dependencies (you only need to do this once):

   yarn install

3. Modify config.json in public directory with your homeserver details.
   (See types/IChatterboxConfig.ts for the format)
4. Start develop server:

   yarn start

Build Instructions

---

Follow the develop instructions above (steps 1-3), then:

• Build chatterbox app into /target directory:

  yarn build

Embed Instructions

---

Assuming that the build output (inside /target) is hosted at <root> (eg: chatterbox.element.io), copy and paste the following snippet before the closing </body> tag:

	<script>
		window.CHATTERBOX_CONFIG_LOCATION = "path_to_config";
	</script>
	<script src="<root>/assets/parent.js" type="module" id="chatterbox-script"></script>

Testing

Chatterbox comes with a suite of integration tests, using cypress.

You can run them by doing

yarn cypress install
yarn cypress open

Ensure you copy the cypress/fixtures/demoInstance.sample.json file to cypress/fixtures/demoInstance.json and edit the keys accordingly.