balachander712 / cometlabs-codingplatform

CometLabs

Prerequisites

Before running the project, ensure that you have the following dependencies installed on your system:

• Docker: https://www.docker.com/get-started

Getting Started

Follow these steps to run the project using Docker:

1. Clone the repository:

   https://github.com/balachander712/CometLabs-codingPlatform

2. Navigate into the Project Directory

3. Create a file named .current.env and copy the env variables sent in the mail

4. Then run:

      docker-compose up --build

You can try testing the endpoint by hitting the endpoint

   http://127.0.0.1:8005/<endpoint>

Please refer to the documentation inside the docs folder for full API documentation. (index.html)

The Screenshots of the API Requests are included inside docs/images directory.