7d038dfef1
This updates old examples to the more universal `npx` command. Fixes https://github.com/vercel/next.js/discussions/12103 |
||
---|---|---|
.. | ||
components | ||
css | ||
models | ||
pages | ||
public | ||
utils | ||
.env.local.example | ||
.gitignore | ||
package.json | ||
README.md | ||
vercel.json |
MongoDB and Mongoose with Next.js
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.
Deploy your own
Deploy the example using Vercel:
How to use
Using create-next-app
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
Download manually
Download the example:
curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-mongodb-mongoose
cd with-mongodb-mongoose
Install and run:
npm install
npm run dev
# or
yarn
yarn dev
Configuration
Step 1. Get the connection string of your MongoDB server
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.
Step 2. Set up environment variables
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.
Step 3. Run Next.js in development mode
npm install
npm run dev
# or
yarn install
yarn dev
Deploy on Vercel
Deploy it to the cloud with Vercel (Documentation).