Skip to content

Contributing Guidelines

If you are a first time contributor, start by reading this fantastic guide.

Read the docs

Get familliar with the stack

Backend:

Frontend:

Development setup

For development purposes, you need to have a working Python and Rust installation.

  • Set up local databases (See database setup)
  • Install Rust and Python
  • Build BOLD cli tools: make release-tools
  • Install Poetry
  • Install necessary dependencies: poetry install
  • Run worker application: make start_worker
  • Run backend server: make start_backend
  • Run docs server: make start_docs
  • Open the BOLD web interface: http://localhost:8000/

For further information proceed to Architechture guide.