Preconditions

1. Visual Studio Code
2. Node.js
3. (optional)Docker Desktop
   The programs in above must be installed.

Steps to Run this Project

1. Clone the repo

git clone https://github.com/malisasmaz/ionapi.git

2. Open terminal in project folder.

3. Run command to install dependencies.

npm install

4. Run command to create build.

npm run build

Two options to Run project

• Local: Run command

npm run start

• Docker: Run command

docker-compose up

To Run Tests

Run command to run tests

npm run test

TechStack

I use TypeScript and Express.js to create REST API. Mocha and Chai for tests.

1. I used Express js for API operations. It is one of the most starred npm packages and a great option for building APIs 😀.

2. I use Mocha and Chai for API test operations. I added tests for each operations.

Database

• MongoDb or other DB implementation can be add (with typeORM)

API Documentation

• Can be add