This template is designed to provide a consistent structure for TypeScript projects for my personal projects.
The docs directory contains important documentation for the project:
docs/design/: This section provides a summary of the choices made and assumptions taken during the development process and offers insights into the application's design rationale and model.docs/requests/request-example.rest: Example REST API requests that can be executed using the VSCode REST Client extension.docs/requests/swagger.yaml: The Swagger API specification file.
This project requires a MongoDB server. A Docker Compose file is provided to create a Docker container with these dependency. To start the service, run:
docker-compose up -d
To run the project on developer mode:
npm run dev
of build the project
npm install
npm run build
npm start
In either scenario, your application should now be reachable via http://localhost:3000.
- For unit tests (using Jest):
npm run test:unit
- For integration tests (using Cucumber and supertest):
npm run test:integration
Integration tests will verify the database connection, but please be aware that running integration tests will result in the deletion of all database data.
It is possible to launch all test together with
npm run test