Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mslifelineway/nestjs-best-practice
Use this repository to setup your project with nestjs, eslint, error handling, logging and i18n and many more features. Stay tuned to get more updated features in this respository.
https://github.com/mslifelineway/nestjs-best-practice
error-handling eslint i18n jest nestjs winston-logger
Last synced: 11 days ago
JSON representation
Use this repository to setup your project with nestjs, eslint, error handling, logging and i18n and many more features. Stay tuned to get more updated features in this respository.
- Host: GitHub
- URL: https://github.com/mslifelineway/nestjs-best-practice
- Owner: mslifelineway
- Created: 2024-10-28T14:40:31.000Z (11 days ago)
- Default Branch: master
- Last Pushed: 2024-10-28T14:48:02.000Z (11 days ago)
- Last Synced: 2024-10-28T17:28:22.148Z (11 days ago)
- Topics: error-handling, eslint, i18n, jest, nestjs, winston-logger
- Language: TypeScript
- Homepage:
- Size: 99.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Project setup
```bash
$ npm install
```
## Compile and run the project
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Run tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Deployment
When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
```bash
$ npm install -g mau
$ mau deploy
```
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
## Resources
Check out a few resources that may come in handy when working with NestJS:
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
## I18n - Configuration
- Place all the translation files in the directory /resources/i18n
- File extension must be in this format : .yaml (Ex: en.yaml)
- You can change file extension and path by modifying configuration in `src>utility>i18n>i18n.config.ts` file.
## Logger - Configuration
- Add following configuration variables in application-dev.yaml
```bash
src/resources/application-dev.yaml
# LOGGER
LOGGER:
LEVEL: debug
FILE_NAME: app.log
ERROR_FILE_NAME: error.log
DATE_FORMAT: 'YYYY-MM-DD HH:mm:ss'
```
## Swagger - Configuration
- Add following configuration variables in application-dev.yaml
```bash
src/resources/application-dev.yaml
# SWAGGER
SWAGGER_URL: '/api'
```