vehicle-protection-system

Service to register clients, accidents and affected third parties.

Endpoints documentation

You can find the endpoints documentation here.

Getting Started

Prerequisites

• Node.js (> v16)
• PostgreSQL (> v10)

Runnig the project

First, you need to create a .env file in the root of the project, based on the .env.example file.

Then, you need to install the dependencies:

npm install

Insert Postgres connection string in the .env file (DATABASE_URL variable) and run the migrations:

npm run migrations:execute

And finally, you can run the project:

npm run start

That's it! The project will be running on localhost:${PORT}.

Useful commands

Creating migrations:

npm run typeorm migration:create src/database/migrations/{migrationName}

Reverting migrations:

npm run migrations:revert

Running tests:

npm run test

Running lint verification:

npm run lint