|
| 1 | +<p align="center"> |
| 2 | + <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a> |
| 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="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> |
| 9 | + <p align="center"> |
| 10 | +<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> |
| 11 | +<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> |
| 12 | +<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> |
| 13 | +<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> |
| 14 | +<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> |
| 15 | +<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> |
| 16 | +<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> |
| 17 | +<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> |
| 18 | + <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a> |
| 19 | + <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> |
| 20 | + <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> |
| 21 | +</p> |
| 22 | + <!--[](https://opencollective.com/nest#backer) |
| 23 | + [](https://opencollective.com/nest#sponsor)--> |
| 24 | + |
| 25 | +## Description |
| 26 | + |
| 27 | +[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. |
| 28 | + |
| 29 | +## Project setup |
| 30 | + |
| 31 | +```bash |
| 32 | +$ npm install |
| 33 | +``` |
| 34 | + |
| 35 | +## Compile and run the project |
| 36 | + |
| 37 | +```bash |
| 38 | +# development |
| 39 | +$ npm run start |
| 40 | + |
| 41 | +# watch mode |
| 42 | +$ npm run start:dev |
| 43 | + |
| 44 | +# production mode |
| 45 | +$ npm run start:prod |
| 46 | +``` |
| 47 | + |
| 48 | +## Run tests |
| 49 | + |
| 50 | +```bash |
| 51 | +# unit tests |
| 52 | +$ npm run test |
| 53 | + |
| 54 | +# e2e tests |
| 55 | +$ npm run test:e2e |
| 56 | + |
| 57 | +# test coverage |
| 58 | +$ npm run test:cov |
| 59 | +``` |
| 60 | + |
| 61 | +## Deployment |
| 62 | + |
| 63 | +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. |
| 64 | + |
| 65 | +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: |
| 66 | + |
| 67 | +```bash |
| 68 | +$ npm install -g mau |
| 69 | +$ mau deploy |
| 70 | +``` |
| 71 | + |
| 72 | +With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. |
| 73 | + |
| 74 | +## Resources |
| 75 | + |
| 76 | +Check out a few resources that may come in handy when working with NestJS: |
| 77 | + |
| 78 | +- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. |
| 79 | +- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). |
| 80 | +- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). |
| 81 | +- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. |
| 82 | +- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). |
| 83 | +- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). |
| 84 | +- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). |
| 85 | +- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). |
| 86 | + |
| 87 | +## Support |
| 88 | + |
| 89 | +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). |
| 90 | + |
| 91 | +## Stay in touch |
| 92 | + |
| 93 | +- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec) |
| 94 | +- Website - [https://nestjs.com](https://nestjs.com/) |
| 95 | +- Twitter - [@nestframework](https://twitter.com/nestframework) |
| 96 | + |
| 97 | +## License |
| 98 | + |
| 99 | +Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE). |
0 commit comments