This Prisma Backend Boilerplate
is a starter project for building a backend with Prisma and Node.js.
Clone the project:
Open your terminal or command prompt and run the following command to clone the project repository:
git clone
Navigate into the project directory:
Use the cd command to navigate into the project directory:
cd Prisma-Backend-Boilerplate
Install project dependencies:
Next, install the project dependencies by running the following command:
npm i install
- Configure Prisma and the database connection:
- Add Prisma as a development dependency by running the following command:
npm i prisma --save-dev
- Set up your Prisma project by creating the Prisma schema file using the following command:
npx prisma init
- Open the prisma/schema.prisma file and configure your database connection details.
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
- Create a .env file in the project root directory and set the DATABASE_URL environment variable. Replace the placeholders with your database connection details:
DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE?schema=SCHEMA"
- Creating the database schema
- Migrate the database schema: Use the following command to create and apply the initial database schema:
npx prisma migrate dev --name init
This command creates a new migration file based on your schema changes and applies it to your database.
Install Prisma Client:
Install the Prisma Client library by running the following command:
yarn add @prisma/client
Dynamic Modules template generator:
You can create Modules Folder with controller, service, validations, constants, routes by this command dynamically:
node generateFile.ts <moduleFolderName> <moduleName>
// Like node generateFile.ts User user
This command installs the Prisma Client, which provides an interface to interact with your database.
Happy coding!