Learn how to create a new Node.js or TypeScript project from scratch by connecting Prisma to your MongoDB database and generating a Prisma Client for database access. The following tutorial introduces you to the Prisma CLI and Prisma Client.
In order to successfully complete this guide, you need:
Node.js installed on your machine
Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using MongoDB Atlas.
The MongoDB database connector uses transactions to support nested writes. Transactions require a replica set deployment. The easiest way to deploy a replica set is with Atlas. It's free to get started.
See System requirements for exact version requirements.
As a first step, create a project directory and navigate into it:
Next, initialize a TypeScript project and add the Prisma CLI as a development dependency to it:
This creates a
package.json with an initial setup for your TypeScript app.
Next, create a
tsconfig.json file and add the following configuration to it:
Next, initialize a Node.js project and add the Prisma CLI as a development dependency to it:
This creates a
package.json with an initial setup for a Node.js app.
You can now invoke the Prisma CLI by prefixing it with
Next, set up your Prisma project by creating your Prisma schema file with the following command:
This command created a new directory called
prisma which contains a file named
schema.prisma and a
.env file in the root of the project.
schema.prisma contains the Prisma schema with your database connection and the Prisma Client generator.
.env is a dotenv file for defining environment variables (used for your database connection).