Starter App with NestJS Swagger, ClerkJS, and Mongoose

This repository contains a starter application built with NestJS 10.0.1 and TypeScript. It integrates Swagger for API documentation, ClerkJS for authentication, and Mongoose as the database ORM.

Prerequisites

Make sure you have the following software installed on your machine:

• Node.js (version 16 or above)
• MongoDB (installed and running)

Getting Started

To get started with this starter app, follow these steps:

1. Clone the repository:

   git clone https://github.com/bezzietech/nestjs-starter-app.git

2. Install the dependencies:

   cd nestjs-starter-app
   npm install

3. Configure the environment variables:

   Create a .env file in the project root directory and add the following environment variables:

   NODE_ENV=development
   HOST=0.0.0.0
   PORT=3000
   SWAGGER_APP_TITLE="NestJS Starter by BezzieTech"
   CLERK_JWT_VERIFICATION_KEY="Grab the JWT verification key from Clerk Dashboard"
   MAIL_HOST="mail.google.com"
   MAIL_PASSWORD="secret"
   MAIL_PORT=465
   MAIL_USERNAME="someone@gmail.com"
   REQUIRE_TLS=true
   SECURE_MAIL=true
   MONGODB_URI="mongodb://localhost:27017/myawesome-db"
   

4. Run the application:

   npm run dev

   This command will start the application in development mode. You can access it at http://localhost:3000.

Project Structure

The project follows a modular structure and includes the following directories:

• src: Contains the application source code.
  • auth: Contains the JWT related stuff for Clerk Authentication.
  • shared: Contains decroators, Exception filters, Role Guards, Logger and Http Interceptors, Validation pipes and a small util code to send e-mail
• swagger-static: Contains the HTML,CSS and JS required to load swagger

Swagger Documentation

This starter app includes Swagger for API documentation. Once the application is running, you can access the Swagger UI at http://localhost:3000/swagger. The Swagger UI provides a detailed documentation of the available endpoints, request/response schemas, and allows you to test the APIs directly from the interface.

ClerkJS Integration

ClerkJS is used for authentication in this starter app. It provides a secure and customizable user authentication and management system. To integrate ClerkJS further into your application, you can explore the src/auth directory, which contains the necessary configuration and middleware for handling user authentication.

Mongoose Integration

Mongoose is used as the database ORM in this starter app. The src/models directory contains the Mongoose models representing your application's data structures. You can create additional models or modify the existing ones according to your application's requirements.

Additional Information

For more information on how to use NestJS, Swagger, ClerkJS, and Mongoose, please refer to their respective documentation:

• NestJS: https://docs.nestjs.com
• Swagger: https://swagger.io
• ClerkJS: https://docs.clerk.dev
• Mongoose: https://mongoosejs.com

License

This starter app is licensed under the MIT License. Feel free to modify and use it to kickstart your NestJS projects!