3ad55721d1
**Reasons for making this change:**
- it is contained within `node_modules/`, which is already ignored
- the previous versions, which were not in `node_modules/`, did not have
a period at the beginning of the filename
Links to documentation supporting these rule changes:
**Changelog with proof here:**
|
||
|---|---|---|
| .. | ||
| pages | ||
| public | ||
| styles | ||
| util | ||
| .env.local.example | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
Example app using Couchbase
Couchbase is a modern database for enterprise applications. This example will show you how to connect to and use Couchbase in your Next.js app.
If you want to learn more about Couchbase, visit the following pages:
Deploy your own
Deploy the example using Vercel once you have access to the environment variables you'll need or preview live with StackBlitz
How to use
Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-couchbase with-couchbase-app
yarn create next-app --example with-couchbase with-couchbase-app
pnpm create next-app --example with-couchbase with-couchbase-app
Deploy it to the cloud with Vercel (Documentation).
Configuration
Set up a Couchbase database
Set up a Couchbase database either locally or with Couchbase Cloud.
Local installation can be accomplished through a variety of methods, but Docker is the simplest.
After Couchbase is installed, set up a cluster by following this tutorial.
- NOTE: the eventing and analytics services can be unchecked if memory is a constraint (this is often the case with docker and other local installations).
A variety of sample buckets can be installed to get up and running with a data model quickly.
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
Set each variable on .env.local:
COUCHBASE_USERNAME- The username of an authorized user on your Couchbase instanceCOUCHBASE_PASSWORD- The corresponding password for the username specified aboveCOUCHBASE_ENDPOINT- The endpoint to connect to. Uselocalhostfor a local instance of Couchbase, or the Wide Area Network address for a cloud instance.COUCHBASE_BUCKET- The bucket you'd like to connect to for testing.IS_CLOUD_INSTANCE-trueif you are trying to connect to an instance of Couchbase Cloud,falseotherwise.
Run Next.js in development mode
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 will either see a message stating "You are connected to Couchbase" or "You are NOT connected to Couchbase". Ensure that you have provided the correct environment variables.
When you are successfully connected, you can refer to the Couchbase Node.js SDK docs for further instructions on how to query your database.
Deploy on Vercel
You can deploy this app to the cloud with Vercel (Documentation).
Deploy Your Local Project
To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.
Notes
-
When you import your project on Vercel, make sure to click on Environment Variables and set the keys to match your
.env.localfile. -
For a cloud deployment on Vercel, the Environment Variables values will need to correspond to a cloud instance of Couchbase (localhost will NOT connect from a remote server such as Vercel). Find info on getting started with Couchbase cloud.
- Important: you will have to allowlist 0.0.0.0/0 as the IP address, since Vercel's serverless deployments use dynamic IP addresses