gem-hunter
Language: TypeScript
πΉπ A starter kit for NestJS with Prisma, Passport, Zod, Swagger, and more. Built to be a solid foundation for YOUR next project ππΉ.
NOTE: Any folder which is not a NestJS module we prefix it with
_this makes the view better in code editor & separate of concerns.
Welcome to the NestJS Starter Kit π This starter is opensource and provides a robust backend framework using NestJS with Prisma for database management, PostgreSQL as the database, Zod for schema validation, Resend email service, and TypeScript for type safety. Complete Authentication and Authorization are also included out of the box using PassportJS strategies JWT access & refresh tokens.
NOTE: Join the Innovators Lounge Discord Server for free to get support and be an innovator member π
pnpm dlx @compodoc/compodoc -p tsconfig.json -sThis guide will walk you through how to set up, configure, and run the NestJS starter kit on your local machine OR skip this and go to Docker Setup to avoid installing tools.
Make sure you have the following installed:
To get started with this starter kit, follow these steps:
Clone the repository:
git clone https://github.com/mr-meselmani/nestjs-starter-kit.git
Navigate to the project directory:
cd nestjs-starter-kitInstall dependencies:
pnpm install
Set up Environment Variables:
.env file in the root directory..env.example into .env and configure any necessary environment variables and make sure to read notes written inside the .env file. For Local, make sure DATABASE_URL is set to use the HOST as localhost.Make a database migration using the script defined in the package.json file by running:
pnpm db:migrate
Run the seed command to seed the database by some data defined in prisma/seed/data:
pnpm db:seed
Run the application:
pnpm start:dev
After running the application, you can access the Swagger API documentation at http://localhost:3000/doc. You can modify the code to fit your project requirements.
To run the project using Docker, make sure Docker is installed and running on your machine. Follow these steps:
Clone the Repository:
git clone https://github.com/mr-meselmani/nestjs-starter-kit.git
Navigate to the Project Directory:
cd nestjs-starter-kitSet up Environment Variables:
.env file in the root directory..env.example into .env and configure any necessary environment variables. For Docker, make sure DATABASE_URL is set to use the HOST as postgres (the name of the database service in the docker-compose.yml file).Run the Project with Docker Compose:
docker-compose up -d
This command will build and run the application and a PostgreSQL container, as defined in the docker-compose.yml file.
Apply Database Migrations: Once the containers are running, apply database migrations using the following command:
docker-compose exec app pnpm prisma migrate deployReplace app with the name of the service in your docker-compose.yml file if itβs different.
Access the Application:
The application should be available at http://localhost:3000/doc on your local machine.
We welcome contributions from the community. If you'd like to contribute, please follow these steps:
only to development branch.Please ensure your code follows the project's coding standards and very well tested.
If you find this project helpful and would like to support its development, please consider sponsoring this project. You can send contributions using the following cryptocurrency:
HevTaAxB36eqHFhLEYcDnZJtySBebQUbaxBBaau5qyinYour contributions will help ensure the continued development and maintenance of this starter kit. Thank you for your support π€
This project is licensed under the MIT License. See the LICENSE file for more details.
Thank you for checking out the NestJS Starter Kit π Happy coding π