Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.04 KB

README.md

File metadata and controls

49 lines (32 loc) · 1.04 KB

Nestjs Mongoose Boilerplate

A simple nestjs boilerplate that includes the basic and curcial features to help start your project quickly.

Features

  • Mongoose
  • Config Service
  • Swagger
  • Authentication
  • Access Control (CASL)
  • Pagination Middleware

Getting Started

To get a local copy up and running follow these steps.

Installation

  1. Click on use template and click new repository.

  2. Navigate to the project directory.

    cd <repository_directory>
  3. Create a .env file and populate it with the required environment variables provided in the .env.example file.

  4. Install the dependencies.

    npm install
  5. If you haven't installed MongoDB on your system, run the Docker image using the following command:

    docker compose up -d

Usage

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.