Setting up your local environment

• Checkout this repository
• Run make to enter development virtual environtment
• Run make launch at the local root to begin development. This:
  • Installs all dependencies
  • Sets up the Docker containers
• Run code . to open the environment in VSCode
• Run the appropriate commands to start the services. For example, to start all services, run make dev-all.

Tearing down

• Run make down to clean up the environment.
• Exit the shell.

Apps running and ports used

• 3000 - User documentation, available at http://localhost:3000
• 3001 - Generated API documentation available at http://localhost:3001
• 8080 - Backend app
• 6379 - Redis keystore
• 5432 - Postgres DB

Required subscriptions

In addition, you will need to subscribe to the following.

• Twilio (SMS API)

Do note that you Twilio requires counteies to be enabled on its dashboard. For certain countries (e.g. MENA), paperwork has to be submitted for the number to be approved by the government. Please purchase a number from Twiio with SMS support, and enable the number.

• Postmark (Email API)

Please sign up and generate an API key from Postmark here