Skip to content
Snippets Groups Projects
README.md 996 B
Newer Older
  • Learn to ignore specific revisions
  • Midhun Suresh's avatar
    WIP
    Midhun Suresh committed
    Chatterbox lets you securely embed [Hydrogen](https://github.com/vector-im/hydrogen-web) within any website.
        
    ### Develop Instructions
    ---
    1) Clone the repo.
    2) Install dependencies (you only need to do this once):
        ```properties
        yarn install
        ```
    3) Modify config.json in `public` directory with your homeserver details.  
    (See `types/IChatterboxConfig.ts`)
    4) Start develop server:
        ```properties
        yarn start
        ```
    
    ### Build Instructions
    ---
    Follow the develop instructions above (steps 1-3), then:
    - Build chatterbox app into `/target` directory:
        ```properties
        yarn build
        ```
    
    ### Embed Instructions
    ---
    
    Midhun Suresh's avatar
    Midhun Suresh committed
    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:
    ```html
    	<script>
    
    		window.CHATTERBOX_CONFIG_LOCATION = "path_to_config";
    
    Midhun Suresh's avatar
    Midhun Suresh committed
    	</script>
    	<script src="<root>/parent/assets/parent.js" type="module" id="chatterbox-script"></script>
    ```