Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itzshoaib/nestjs-boilerplate
A NestJS Boilerplate project with Mongoose, Passport, JWT, Docker, SwaggerAPI.
https://github.com/itzshoaib/nestjs-boilerplate
crud docker mongodb mongoose nestjs nestjs-backend nestjs-boilerplate nestjs-crud nestjs-dockerized nestjs-mongoose nestjs-starter-template nestjs-swagger swagger
Last synced: 6 days ago
JSON representation
A NestJS Boilerplate project with Mongoose, Passport, JWT, Docker, SwaggerAPI.
- Host: GitHub
- URL: https://github.com/itzshoaib/nestjs-boilerplate
- Owner: ITZSHOAIB
- License: mit
- Created: 2023-12-22T11:39:13.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-01-02T15:04:54.000Z (11 months ago)
- Last Synced: 2024-01-03T15:57:35.731Z (11 months ago)
- Topics: crud, docker, mongodb, mongoose, nestjs, nestjs-backend, nestjs-boilerplate, nestjs-crud, nestjs-dockerized, nestjs-mongoose, nestjs-starter-template, nestjs-swagger, swagger
- Language: TypeScript
- Homepage:
- Size: 128 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# NestJS Boilerplate with clean structure
[](https://github.com/new?template_name=nestjs-boilerplate&template_owner=ITZSHOAIB)
A NestJS project template for building scalable and production-ready REST APIs using [NestJS](https://nestjs.com/), a progressive Node.js framework. NestJS Boilerplate includes many features and libraries, such as:
- Docker support using [Docker Compose](https://docs.docker.com/compose/)
- MongoDB integration using [@nestjs/mongoose](https://docs.nestjs.com/techniques/mongodb) and [Mongoose](https://mongoosejs.com/)
- Open API documentation using [swagger](https://docs.nestjs.com/openapi/introduction)
- Validation using [class-validator](https://docs.nestjs.com/pipes#class-validator)
- A Basic clean folder structure with CRUD operation to get started.
- Testing using [Jest](https://jestjs.io/) and [Supertest](https://github.com/visionmedia/supertest)
- Authentication and authorization using [Passport](https://github.com/jaredhanson/passport) and [JWT](https://jwt.io/)
## Getting Started
To run this project, you need to have [Node.js](https://nodejs.org/en/), [npm](https://www.npmjs.com/), and [Docker](https://www.docker.com/) installed on your machine.
### Installation
Clone this repository and install the dependencies:
```bash
git clone https://github.com/ITZSHOAIB/nestjs-boilerplate.git
cd nestjs-boilerplate
npm install
```
Copy the `default.env` file and rename it to `.env`. Fill in the required environment variables, such as the database URL, and ports.
### Running the app
To run the app in development mode, use:
```bash
npm run start:dev
```
To run the app in production mode, use:
```bash
npm run start:prod
```
To run the app in a Docker container, use:
```bash
docker-compose up
```
The app will be available at `http://localhost:${PORT}`.
### Testing the app
To run the unit tests, use:
```bash
npm run test
```
To run the end-to-end tests, use:
```bash
npm run test:e2e
```
## API Documentation
The app uses [Swagger](https://swagger.io/) to document the API endpoints. You can access the Swagger UI at `http://localhost:${PORT}/api`.
## Contributing
We welcome contributions from the community.
## License
This project is licensed under the MIT License.