Customers API

Deploy status

Tests coverage

Statements	Branches	Functions	Lines

Overview

This project is a customers API built in NodeJs. The project access to non relational database using MongoDB. Below you see the main steps to run project and run automatization tests. The main libraies and resources used in this project was:

💻 - Development

• Nodejs
• MongoDB
• Express

✅ - Testing

• Mocha
• Chai
• Sinon
• Sinon-mongo

📄 - Contract Testing

• Supertest
• Joi
• Chai

Directory structure

node-customers-api-tests/
├── __mocks__/
│     └── ...
├── __tests__/
│     ├── unit/
│     │    └── ...
│     └── contract/
│          └── ...
├── coverage/
│     └── ...
├──  .nyc_output
│     └── ...
├── docs/
│     ├── [DOCUMENTATION FILES]
│     └── ...
├── dev_scripts/
│     ├── output/
│     │    └── ...
│     └── [SCRIPTS FILES]
├── src/
│     ├── config/
│     │    ├── [CONFIG FILES]
│     │    └── ...
│     ├── routes/
│     │    ├── [ROUTES FILES]
│     │    └── ...
│     ├── services/
│     │    ├── [SERVCES FILES]
│     │    └── ...
│     ├── controllers/
│     │    ├── [CONTROLLERS FILES]
│     │    └── ...
│     ├── utils/
│     │    ├── [UTILS FILES]
│     │    └── ...
│     └── index.js
├── .gitignore
├── LICENSE.md
├── package-lock.json
├── package.json
└── README.md

Get Started

First is important to know that this project contains environment variables, that you have use. The local variables are in .env.local and production enviroment variables are in .env.prod. So, to setup your development environment, run:

cp .env.local .env

Necessary variables enrironments:

UI_URL_APP=''
MONGO_DB_URI=''
MONGO_DB_NAME=''
USER_API_AUTH=''
PASS_API_AUTH=''

Install dependencies

First, install dependencies:

npm install

Run

To run the project, you can execute this command below:

npm start

Quality and test automation

See below the project's unit test coverage and how to run the tests:

Tests

To execute unit tests, run:

npm run test

To run coverage to unit tests, run:

npm run coverage

To run contract tests, run:

npm start

and in other terminal, run:

npm run contract

Contact

Created by: @marialuisacp - contato@malu.dev