To run this project you will need:
.env
file is read when in production..env.dev
file is read when callingyarn dev
(development environment)..env.test
file is read when callingyarn test
(test environment).
You can use .env.sample
to know how to configure the .env
to your needs.
.env.sample
also contains the environment defaults.
yarn prisma migrate dev
to generate/sync database accordingly to migrations (or generate migration ifschema.prisma
was modified).yarn dev
to run app in development environment.yarn test
to run tests.yarn prod
to build TypeScript to JavaScript then run app in production environment simulation.
http://{host}:{port}/docs
default: http://localhost:4000/docs
- TypeScript
- HTTP Server: routing-controllers and express
- Database: prisma
- Requests validations: class-validator
- API documentation: swagger-ui-express
- Tests: jest
- Logs: winston