Intelup

Getting Started

These instructions will get you a copy of the project up and running on your local machine for testing and production purposes.

Prerequisites

• MongoDB For development purposes
• Nodejs && NPM - For development purposes
• Docker - For production purposes
• Compose - For production purposes

Installing

A step by step that gets your devlopment environment running:

Install project dependencies:

npm install

Env

Rename .env.example to .env:

mv .env.example .env

Running the tests

Use the test script to run the tests:

npm run test

Use this script to run live tests:

npm run test:live

Running with Docker

Starting the project running in docker with docker-compose

Make sure the two containers (database and API) ports aren't being used by something else

docker-compose up -d

Docs

There is a Swagger API documentation in ./docs/swagger to import at swagger editor

Built With

• Express - The framework used

• MongoDB - The famous NoSQL database

• Mongoose - The MongoDB object modeling for node.js

• Json Web Token - A compact and self-contained way for securely transmitting information

Author

• Douglas E. Alves

License

This project is licensed under the MIT License - see the LICENSE file for details