STRV Project - Address Book

Getting started

The following is a Node.js API using Express.js that implements the address-book project.

Environment

There are 3 different environments (production, development, and test). In order to execute the API in one of them, use the following commands:

1. Production mode:
   npm start

2. Development mode:
   npm run dev

3. Run the Test suite:
   In order to run the test, use docker-compose to use a Postgres database with the command npm run mount
   then run npm test or npm run test:coverage. Finally run npm run unmount to stop docker-compose.

Project Structure

The API manage the following structure:

TestProject
├── package.json
├── src
│   ├── app.js
│   ├── bin
│   ├── configuration
│   │   ├── env
│   │   ├── migrations
│   │   ├── seeders
│   ├── controllers
│   ├── middlewares
│   ├── models
│   ├── routes
│   └── utils
└── tests
    ├── integration
    ├── unit
    └── utils

Documentation

API Swagger Documentation is available here

Contributing

All changes are welcome. If you run into any bugs, please file an issue and explain it.