development_guide.md

Development guide

Style guide

• The frontend code uses ES lint and prettier. This can be integrated into your IDE or manually run with:

  cd frontend && npm run lint

A workflow is integrated into GitHub action to check that any code push has been first processed with the project settings. See code style workflow

Starting points

• Backend:
  • django
  • django-rest-framework
• Frontend:
  • react
  • react-router
  • vite
• API documentation can be found at here while running locally or here for staging environment. You can also find a link to it in admin page, in the top right corner, next to your username.

Adding a new backend dependency

To add a new dependency:

• Add it to requirements.txt
• Create a new virtualenv and activate it

  virtualenv .venv && source .venv/bin/activate

• Install all dependencies

  pip install -r requirements.txt

• Freeze the new constraints

  pip freeze > requirements.txt