2017-10-11 10:29:26 +00:00
< p align = "center" >
2022-08-04 02:06:53 +00:00
< a href = "http://nestjs.com/" target = "blank" > < img src = "https://nestjs.com/img/logo-small.svg" width = "120" alt = "Nest Logo" / > < / a >
2017-10-11 10:29:26 +00:00
< / p >
2017-02-25 14:16:12 +00:00
2020-11-16 09:19:40 +00:00
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
2024-08-19 10:26:13 +00:00
2020-11-16 09:19:40 +00:00
< 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 >
2017-10-11 10:29:26 +00:00
< p align = "center" >
2020-11-16 09:19:40 +00:00
< 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://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 >
2019-07-03 22:50:56 +00:00
< a href = "https://discord.gg/G7Qnnhy" target = "_blank" > < img src = "https://img.shields.io/badge/discord-online-brightgreen.svg" alt = "Discord" / > < / a >
2020-11-16 09:19:40 +00:00
< 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 >
2022-03-19 12:22:55 +00:00
< a href = "https://paypal.me/kamilmysliwiec" target = "_blank" > < img src = "https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt = "Donate us" / > < / a >
2020-11-16 09:19:40 +00:00
< 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 >
2022-03-19 12:22:55 +00:00
< 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 >
2017-10-11 10:29:26 +00:00
< / p >
<!-- [](https://opencollective.com/nest#backer)
[](https://opencollective.com/nest#sponsor)-->
2017-02-25 14:16:12 +00:00
2017-10-11 10:29:26 +00:00
## Description
2018-03-27 11:47:26 +00:00
[Nest ](https://github.com/nestjs/nest ) framework TypeScript starter repository.
2017-12-17 17:36:31 +00:00
2024-08-19 10:26:13 +00:00
## Project setup
2017-02-25 14:16:12 +00:00
2017-10-11 10:29:26 +00:00
```bash
2017-02-25 14:16:12 +00:00
$ npm install
```
2024-08-19 10:26:13 +00:00
## Compile and run the project
2017-02-25 14:16:12 +00:00
2018-03-26 18:42:17 +00:00
```bash
# development
2017-02-25 14:16:12 +00:00
$ npm run start
2018-03-26 18:42:17 +00:00
# watch mode
$ npm run start:dev
# production mode
2019-02-01 06:32:32 +00:00
$ npm run start:prod
2017-02-25 14:16:12 +00:00
```
2017-05-14 20:57:43 +00:00
2024-08-19 10:26:13 +00:00
## Run tests
2017-12-17 17:36:31 +00:00
2018-03-26 18:42:17 +00:00
```bash
# unit tests
2017-12-17 17:36:31 +00:00
$ npm run test
2018-03-26 18:42:17 +00:00
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
2017-12-17 17:36:31 +00:00
```
2024-08-19 10:26:13 +00:00
## 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/ ).
2024-10-16 10:08:15 +00:00
- Deploy your application to AWS with the help of [NestJS Mau ](https://mau.nestjs.com ) in just a few clicks.
2024-08-19 10:26:13 +00:00
- 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 ).
2018-03-26 17:23:10 +00:00
## Support
2018-03-28 17:26:22 +00:00
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 ).
2017-05-14 20:57:43 +00:00
2018-03-26 17:23:10 +00:00
## Stay in touch
2017-05-14 20:57:43 +00:00
2020-01-08 12:01:44 +00:00
- Author - [Kamil Myśliwiec ](https://twitter.com/kammysliwiec )
2017-10-07 11:19:50 +00:00
- Website - [https://nestjs.com ](https://nestjs.com/ )
2018-03-26 17:23:10 +00:00
- Twitter - [@nestframework ](https://twitter.com/nestframework )
2017-10-11 10:29:26 +00:00
2018-03-26 17:23:10 +00:00
## License
2017-10-11 10:29:26 +00:00
2024-08-19 10:26:13 +00:00
Nest is [MIT licensed ](https://github.com/nestjs/nest/blob/master/LICENSE ).