MongoDB is a general purpose, document-based, distributed database built for modern application developers and for the cloud era. This example will show you how to connect to and use MongoDB as your backend for your Next.js app.
If you want to learn more about MongoDB, visit the following pages:
Once you have access to the environment variables you'll need, deploy the example using Vercel:
Execute create-next-app with npm or Yarn to bootstrap the example:
npx create-next-app --example with-mongodb with-mongodb-app
# or
yarn create next-app --example with-mongodb with-mongodb-appSet up a MongoDB database either locally or with MongoDB Atlas for free.
Copy the env.local.example file in this directory to .env.local (which will be ignored by Git):
cp .env.local.example .env.localSet each variable on .env.local:
MONGODB_URI- Your MongoDB connection string. If you are using MongoDB Atlas you can find this by clicking the "Connect" button for your cluster.MONGODB_DB- The name of the MongoDB database you want to use.
npm install
npm run dev
# or
yarn install
yarn devYour app should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.
You will either see a message stating "You are connected to MongoDB" or "You are NOT connected to MongoDB". Ensure that you have provided the correct MONGODB_URI and MONGODB_DB environment variables.
When you are successfully connected, you can refer to the MongoDB Node.js Driver docs for further instructions on how to query your database.
You can deploy this app to the cloud with Vercel (Documentation).
To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.
Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.
Alternatively, you can deploy using our template by clicking on the Deploy button below.