This example shows how you can use a MongoDB database to support your Next.js application.
Pet is an application that allows users to add their pets' information (e.g., name, owner's name, diet, age, dislikes, likes, and photo). They can also delete it or edit it anytime.
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-mongoose with-mongodb-mongoose-app
# or
yarn create next-app --example with-mongodb-mongoose with-mongodb-mongoose-app
# or
pnpm create next-app -- --example with-mongodb-mongoose with-mongodb-mongoose-app
In the case of MongoDB Atlas, it should be a string like this:
mongodb+srv://<username>:<password>@my-project-abc123.mongodb.net/test?retryWrites=true&w=majority
For more details, follow this MongoDB Guide on how to connect to MongoDB.
Copy the .env.local.example
file in this directory to .env.local
(which will be ignored by Git):
cp .env.local.example .env.local
Then set each variable on .env.local
:
MONGODB_URI
should be the MongoDB connection string you got from step 1.
npm install
npm run dev
# or
yarn install
yarn dev
Your app should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.
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.