Before we get started, you should have the latest version of docker (19.03.0+) and git (2.13+) installed. For a local deploy, we suggest configuring docker to use at least 16GB of memory, 4 CPUs, and 256 GB of disk space.

Clone the highlight.io repository and make sure to checkout the submodules with the --recurse-submodules flag.

Navigate into the highlight/docker directory of the repo.

In the highlight/docker directory, set the environment variable COMPOSE_FILE as specified. This will enable hot reloading of both our backend and frontend.

In the highlight/docker directory, run docker compose up --build -d to start the docker containers.

Visit https://localhost:3000 to view the dashboard and go through the login flow; there are no login credentials required.

After clicking around on the dashboard for a bit, you should see a session appear at https://localhost:3000/1/sessions. Click on the session to view the session details page.

Having issues? Here's some things ot try. First run the docker ps command and ensure that all containers are in a 'healthy' state. As a second step, run docker compose logs -f backend frontend to see the logs for the backend and frontend containers. If this doesn't help w/ troubleshooting, please reach out.