This project is configured to run in GitHub Codespaces. To start developing, create a codespace for this project if you haven't already, and open that codespace in your editor of choice. All secrets are already configured.
To develop in a local devcontainer, you need to have Docker installed. Then, open the project in VSCode, and click the green button in the bottom left corner to open the project in a devcontainer. You will need to add a secret .env
file. Ask in slack for the secrets.
You need golang and nodejs installed to run the backend and frontend locally. You will need a secret .env
file. Ask in slack for the secrets.
To start the backend, run make backend
. The bakcend will be listening on port 8000 of localhost.
To start the dashboard, run make frontend
. The dashboard will be listening on port 3000 of localhost.
The API documentation for the backend is available at SwaggerHub.