A simple nestjs boilerplate that includes the basic and curcial features to help start your project quickly.
- Mongoose
- Config Service
- Swagger
- Authentication
- Access Control (CASL)
- Pagination Middleware
To get a local copy up and running follow these steps.
-
Click on use template and click new repository.
-
Navigate to the project directory.
cd <repository_directory>
-
Create a
.env
file and populate it with the required environment variables provided in the.env.example
file. -
Install the dependencies.
npm install
-
If you haven't installed MongoDB on your system, run the Docker image using the following command:
docker compose up -d
To start the development server, run the following command:
npm run start:dev
The server should now be running at http://localhost:<port>
. You can access the endpoints using a tool like Postman or any web browser.