Skip to main content

Launching the App

Run the Server For Development​

You can run your development environment using either docker or node:

  1. To run the widget with docker, run docker compose up.
  2. To run the widget with node, run npm run dev.
note

The widget relies on redis. If you receive an error about failure to connect redis, start a local redis instance to make it available at localhost:6379 and the widget will be able to use it.

Deploying a Production Instance​

For a production instance, it is easiest to use Docker. We provide docker files for both the server and the UI, along with a docker-compose file that runs all necessary containers, including Redis and ElasticSearch.

The simplest way to deploy this widget is via docker-compose, as shown below, but you can also use the dockerfiles directly.

Take a look at the docker-compose.yml file for more details on how it is set up.

docker compose up

Reminder About Sensitive Information​

Secrets must be passed through environment variables instead of hardcoded in the code files. Do not put any credentials in any of the code files. If you do so, it could get committed and leaked to the public. Use the provided .env files.