M2 Back-end REST project

To run the app, you must have Docker 🐳 , Docker Compose and Node.js installed on your machine.

To install, open a terminal at the root of the project and run:

npm install

The .env file should follow the .env.safe file format

For testing purposes you can use dumb data as:

DATABASE_HOST=localhost
DATABASE_USERNAME=db_user
DATABASE_PASSWORD=db_password
DATABASE_NAME=node_app_db
DATABASE_PORT=5432

⚠️ Obviously this data would be secret in real life.

1. First, open a terminal at the root of the project, and run:

docker-compose up

2. Second, still at the root of the project, run this command to build the project:

npm run build

3. Then make the migration of the database with this command:

npm run migration:run

4. To populate the database run:

• on MacOS/Linux bash scripts/populate-db.sh
• on Windows ./scripts/populate-db.ps1

To reset the database (drop all table):

• on MacOS/Linux bash scripts/reset-db.sh
• Windows ./scripts/reset-db.ps1

To remove all the data without droping tables:

• on MacOS/Linux bash scripts/clear-db.sh
• Windows ./scripts/clear-db.ps1

5. Finally, in the same terminal, run this command to start:

npm run start

This project comes with unit tests, which can be found in the tests directory at the root of this project. These tests are written using Jest.

To run the tests without coverage reports, open a terminal at the root of this project and run:

npm run test

To run the tests and generate a coverage report, open a terminal at the root of this project and run:

npm run test:coverage

The script will run the tests and generate a code coverage report (visible in the command line). Since Jest has Istanbul built in, an HTML version of the coverage report will also be available here after the script's execution.

This project uses Swagger to generate documentation for each endpoint. Once the app is running, the documentation is available at this address (http://localhost:7000/docs).

See the full checkpoints file here.