This repository contains code for asynchronous example api using the Express framework ,Uvicorn server and Postgres Database to perform crud operations on notes.
-
Clone this Repo
-
Install the required packages
npm install
-
Start the app using npm
npm run start:dev
-
Ensure you have a Mongodb Database running locally.
Api documentation generated on docs
-
Ensure Docker is installed.
-
Ensure Docker Compose is installed.
-
Clone this Repo
git clone [repo name]
-
Use Docker-Compose to spin up containers
docker-compose up -d --build
-
If everything is completed successfully, it should be available on notes
Tests are available using npm test command
Run them using npm run test .
while in the root directory (/Credit-Engine)
Documentation is at by Postman