A progressive Node.js framework for building efficient and scalable server-side applications.
Nest framework TypeScript starter repository.
$ npm installOnce the dependencies are installed, you can now configure your project by creating a new .env file containing the environment variables used for development.
cp .env.example .envFor a standard development configuration, you can leave the default values for HOST, BASE_PATH and PORT under the API REST section.
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov# Lint the project files using TSLint
npm run lintThis project follows the GitFlow branching model. Ensure your contributions adhere to this standard.
If you wish to contribute to this project, follow these steps:
- Fork the repository.
- Create a new branch (git checkout -b feature/feature-name).
- Make your changes and commit them (git commit -am 'Add new feature').
- Push your changes to your fork (git push origin feature/feature-name).
- Check to run the comand npm run lint to improve code quality before add your new feature.
- Create a new pull request to develop branch.
The project estructure follows the next convention for every modules under modules folder and global folders to enable common global items
src
|-- common # Common folder contains interfaces, common constants for dependencies inyections used on the whole application
| |-- interfaces
|-- config # Contains configuration to relational and no-relational databases
| |-- database.config.ts
| |-- mongo.config.ts
|-- modules
| |-- name_module
| | |-- name_module.controller.ts
| | |-- name_module.module.ts
| | |-- dto # Contains Data Transfer Objects used in all the module
| | | |-- example.dto.ts
| | |-- entities # Contains Entities defined with classes
| | | |-- example.entity.ts
| | |-- services #Define here the services used for every module including services from external modules
| | | |-- example.service.ts
| | | |-- from_other_module.service.ts
tsconfig.build.json
tsconfig.json- Author - Miguel Martinez
Nest is MIT licensed.