https://github.com/rick-ame/nest-api
Nest.js API
https://github.com/rick-ame/nest-api
docker docker-compose jwt-auth nestjs nestjs-boilerplate prisma swagger
Last synced: about 2 months ago
JSON representation
Nest.js API
- Host: GitHub
- URL: https://github.com/rick-ame/nest-api
- Owner: rick-ame
- License: mit
- Created: 2023-10-11T04:48:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-22T02:40:53.000Z (about 1 year ago)
- Last Synced: 2025-05-22T03:33:56.732Z (about 1 year ago)
- Topics: docker, docker-compose, jwt-auth, nestjs, nestjs-boilerplate, prisma, swagger
- Language: TypeScript
- Homepage:
- Size: 670 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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
This is a [Nest](https://nestjs.com/) starter project. Uses [`Prisma`](https://www.prisma.io/) as DB ORM, implements unit and e2e testing.
## 🧪 .env Setup
Database [MongoDB Atlas](https://www.mongodb.com/) is recommended.
```
DATABASE_URL=your_mongodb_url
JWT_SECRET=your_jwt_secret
PORT=3000 # optional
ENABLE_SWAGGER=1 # optional, or 0 to disable
```
## 🎯 Develop and Run the Project
### Installation
```sh
$ pnpm install
```
**Note**:
- After installation, you may need to run `pnpm prisma generate` manually. It's a known [issue](https://github.com/prisma/prisma/issues/6603) of Prisma.
- Run `pnpm simple-git-hooks` to enable git hooks for linting and testing.
### Compile and Run the project
```sh
# development
$ pnpm run start
# watch mode
$ pnpm run start:dev
# production mode
$ pnpm run build
$ pnpm run start:prod
```
_If swagger is enabled, you can visit `/docs` path._
### Run tests
```bash
# unit tests
$ pnpm run test
# e2e tests
$ pnpm run test:e2e
# test coverage
$ pnpm run test:cov
```
## 🐳 Containerizing
```sh
$ docker-compose up
```
## 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).