templates/ts-nestjs-template-for-community
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(core): 集成全局异常过滤器、响应拦截器、Swagger文档、Helmet安全、限流器及TypeORM迁移支持，完善项目基础结构

Browse Source
This commit is contained in:
dayjoy
2026-03-11 14:39:09 +08:00
parent 886aa79be3
commit ee017f9250
14 changed files with 354 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
README.md
View File

@@ -1,98 +1,117 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>
# Nest App
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
NestJS starter template with TypeORM, Swagger, validation, and security best practices.
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
## Tech Stack
## Description
- **NestJS** v11
- **TypeORM** v0.3 + MySQL
- **Swagger** (OpenAPI)
- **class-validator** + **class-transformer**
- **Helmet** + **ThrottlerModule**
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Project setup
## Project Setup
```bash
$ yarn install
yarn install
```
## Compile and run the project
Copy `.env.example` to `.env` and fill in your database credentials:
```bash
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prod
cp .env.example .env
```
## Run tests
## Run
```bash
# development (watch mode)
yarn start:dev
# production
yarn build
yarn start:prod
```
API is available at `http://localhost:3000/api/v1`
Swagger docs at `http://localhost:3000/api/docs`
## Database Migrations
This project uses TypeORM migrations to manage database schema. **Do not use `synchronize: true`.**
### Generate a migration from Entity changes
After creating or modifying an Entity, generate a migration automatically:
```bash
yarn migration:generate --name=CreateUser
```
This compares your Entity definitions against the current database schema and generates the corresponding SQL.
### Create an empty migration
For manual SQL (seed data, indexes, etc.):
```bash
yarn migration:create --name=SeedData
```
### Run pending migrations
```bash
yarn migration:run
```
### Revert the last migration
```bash
yarn migration:revert
```
### Typical workflow
```bash
# 1. Create or modify an Entity file
# 2. Generate migration
yarn migration:generate --name=AddEmailToUser
# 3. Review the generated file in src/database/migrations/
# 4. Run the migration
yarn migration:run
```
## Project Structure
```
src/
├── common/
│ ├── filters/ # Global exception filter
│ ├── interceptors/ # Response transform interceptor
│ └── interfaces/ # Shared interfaces (ApiResponse)
├── config/
│ └── database.config.ts
├── database/
│ ├── data-source.ts # TypeORM CLI data source
│ └── migrations/ # Migration files
├── app.module.ts
└── main.ts
```
## Testing
```bash
# unit tests
$ yarn run test
# e2e tests
$ yarn run test:e2e
yarn test
# test coverage
$ yarn run test:cov
yarn test:cov
# e2e tests
yarn test:e2e
```
## 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
$ yarn install -g @nestjs/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).
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
[MIT](https://github.com/nestjs/nest/blob/master/LICENSE)