| 1 | <p align="center"> |
| 2 | <a href=" |
| 3 | </p> |
| 4 | |
| 5 | [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 |
| 6 | [circleci-url]: https://circleci.com/gh/nestjs/nest |
| 7 | |
| 8 | <p align |
| 9 | <p align |
| 10 | <a href="https://www.npmjs.com/~nestjscore |
| 11 | <a href="https://www.npmjs.com/~nestjscore |
| 12 | <a href="https://www.npmjs.com/~nestjscore |
| 13 | <a href="https://circleci.com/gh/nestjs/nest |
| 14 | <a href="https://discord.gg/G7Qnnhy |
| 15 | <a href="https://opencollective.com/nest#backer |
| 16 | <a href="https://opencollective.com/nest#sponsor |
| 17 | <a href=" |
| 18 | <a href=" |
| 19 | <a href=" |
| 20 | </p> |
| 21 | <!--[](https://opencollective.com/nest#backer) |
| 22 | [](https://opencollective.com/nest#sponsor)--> |
| 23 | |
| 24 | ## Description |
| 25 | |
| 26 | [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. |
| 27 | |
| 28 | ## Project setup |
| 29 | |
| 30 | ```bash |
| 31 | $ bun install |
| 32 | ``` |
| 33 | |
| 34 | ## Compile and run the project |
| 35 | |
| 36 | ```bash |
| 37 | # development |
| 38 | $ bun run start |
| 39 | |
| 40 | # watch mode |
| 41 | $ bun run start:dev |
| 42 | |
| 43 | # production mode |
| 44 | $ bun run start:prod |
| 45 | ``` |
| 46 | |
| 47 | ## Run tests |
| 48 | |
| 49 | ```bash |
| 50 | # unit tests |
| 51 | $ bun run test |
| 52 | |
| 53 | # e2e tests |
| 54 | $ bun run test:e2e |
| 55 | |
| 56 | # test coverage |
| 57 | $ bun run test:cov |
| 58 | ``` |
| 59 | |
| 60 | ## Deployment |
| 61 | |
| 62 | 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. |
| 63 | |
| 64 | 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: |
| 65 | |
| 66 | ```bash |
| 67 | $ bun install -g @nestjs/mau |
| 68 | $ mau deploy |
| 69 | ``` |
| 70 | |
| 71 | With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. |
| 72 | |
| 73 | ## Observability |
| 74 | |
| 75 | In production applications, observability is essential for understanding how your system behaves, detecting issues early, and maintaining reliable performance. |
| 76 | |
| 77 | [NestJS Observe](https://observe.nestjs.com) automatically instruments your NestJS application, giving you deep visibility into your system with minimal setup: |
| 78 | |
| 79 | - **Distributed tracing:** Follow requests across services and understand how they flow through your system. |
| 80 | - **Waterfall analysis:** Visualize request execution and identify slow operations, bottlenecks, and unexpected delays. |
| 81 | - **Performance analysis:** Analyze application performance in real time and quickly pinpoint areas that need optimization. |
| 82 | - **Metrics:** Track key application and infrastructure metrics to understand system health and performance trends. |
| 83 | - **Logging:** Centralize and correlate logs with traces and other telemetry to make debugging easier. |
| 84 | - **Error tracking:** Detect errors quickly and investigate their root causes with the surrounding context. |
| 85 | - **SLA monitoring:** Track service-level objectives and identify when your application is approaching or exceeding defined thresholds. |
| 86 | - **Alarms and alerts:** Set up alerts for critical errors, performance degradation, SLA violations, and other anomalies so your team can react quickly. |
| 87 | |
| 88 | ## Resources |
| 89 | |
| 90 | Check out a few resources that may come in handy when working with NestJS: |
| 91 | |
| 92 | - Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. |
| 93 | - For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). |
| 94 | - To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). |
| 95 | - Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. |
| 96 | - Auto-instrument your application with [NestJS Observer](https://observer.nestjs.com). Distributed tracing, metrics, and logging made easy. Error tracking and performance monitoring for your NestJS applications. |
| 97 | - Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). |
| 98 | - Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). |
| 99 | - To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). |
| 100 | - Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). |
| 101 | |
| 102 | ## Support |
| 103 | |
| 104 | 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). |
| 105 | |
| 106 | ## Stay in touch |
| 107 | |
| 108 | - Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec) |
| 109 | - Website - [https://nestjs.com](https://nestjs.com/) |
| 110 | - Twitter - [@nestframework](https://twitter.com/nestframework) |
| 111 | |
| 112 | ## License |
| 113 | |
| 114 | Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE). |