Documentation index

Getting started

• Install the dependencies.
• Optional: Check out the useful articles.
• Familiarise yourself with the project structure and the architecture.
• Run task -l to see available tasks.
• Run task to automatically install the Go/Node packages and run the app in development mode.
• Learn the code conventions followed in the project.
• Start exploring the codebase from:
  • The Go entrypoint.
  • The frontend entrypoint.

Development

• Update checklist. Use this when releasing a new version to ensure you don't forget any of the steps.

Documentation structure

This documentation follows the approach proposed by Diátaxis. Familiarise yourself with it if you're editing an article or writing a new one.