ayuba-dn / drones Goto Github PK

An API/Service developed to manage course registration. The API contains endpoints for registering new students, creating new courses and also for registering courses by active students.

1. Clone this repository and open your terminal/command line app in the root folder

2. Install dependencies

npm install

4. Delete docker-compose.yaml file and rename docker-compose-for-mongo-only.yml to docker-compose.yaml

5. (Optional) You can customize the default database and app credentials in both .env and docker-compose.yaml files, ensure values in both files are thesame

6. Run the command below to start mongo container with the required credentials

docker compose up --build

4. Run tests using the command below

npm run test

7. Run the command below to start server (app will run on default port 4000)

npm run dev

The following are the major tools that have been utilized for developing and deploying this service.

• Typescript

• Nodejs

• Express

• Jest

• Supertest

• Docker

• Jenkins

• Helm

• Kubernetes/AWS EKS

Atilola Oyediji Email: [email protected] LinkedIn: Atilola Oyediji Twitter: (https://twitter.com/atilolaoyediji)

📜 END