Skip to content

Development

Install Pre-requisites:

Install Dependencies

poetry install --no-root

Fill Environment variables

Copy env examples

cp .env.example .env 
cp env-backend.example.env env-backend.local.env

Fill configuration options in each file

Commands

  • make run - Run the API locally.
  • make run-worker - Run worker locally.
  • make run-webhooks - Run webhooks emulator that will send webhooks to local API instance.
  • make coverage - Run tests with coverage report.
  • make lint- Run linter.
  • make docs-build - Build the documentation site.
  • make docs-serve - Serves the documentation site.