This API allows CustomerCare operators to reply messages from customers. Messages are collected into tickets that eventually will be resolved by the operators.
The project requires a .env
file with the following content.
PGUSER=api
PGPASSWORD=apiPassword
PGDATABASE=api
PGHOST=localhost
The API can be run using Docker.
Run docker compose up api
to run the database, the database migrations and the API.
Once the API is up and running the database can be populated by running docker compose up seed
.
To set up the development environment Node.js v22 is required.
Run the following commands:
npm ci
docker compose up -d db
npm run migrate:up
npm run seed
Execute npm run serve
to run the API.