• Any operating system that supports Docker
• Minimum 1GB free RAM and 1 vCPU core for a smooth experience

• Docker Community Edition
• Docker Compose plugin
• Internet access (required only for the first run)

1. Clone this repository

2. Copy .env.example to .env:

3. Edit the .env file with appropriate values

4. Build the app:

   docker compose build

5. Start the services using Docker Compose:

   docker compose up -d

• View container status:

  docker compose ps -a

• View live logs:

  docker compose logs -tf

• Stop and remove everything, including volumes:

  docker compose down --volumes

• Detailed information about API endoints have been given in Endpoints.md file

• To run tests use command below given

  yarn test

💡 Tip: Make sure your ports are not in use by other applications before starting the containers.