Skip to content

Latest commit

 

History

History
140 lines (89 loc) · 8.24 KB

README.md

File metadata and controls

140 lines (89 loc) · 8.24 KB
Raw

Couchbase Capella Starter with Next.js

Deployment Instructions

The deployment instructions are specifically for Vercel. If you are deploying on other platforms, you need to adapt the instructions for running the project locally.

Prerequisites

To deploy this project on Vercel, you will need:

  • Vercel Account
  • Access to a Couchbase Capella database running the Query Service. Alternatively, you have the option to sign up for a free Capella database in the integration flow.
  • If you are connecting to an existing Capella account, create a bucket called user_profile, and a collection called profile (within the _default scope).
    • Note: the build step will attempt to create the collection and load the sample data within your CB_BUCKET on deployment.

Steps

Deploy with Vercel

  • Follow the steps when prompted. The integration step will open the Couchbase Capella UI and allow you to select resources to connect.
  • Explore the newly deployed application: create, update, and delete some user profiles. A few sample profiles will be added automatically, and you can load the sample data manually by following these instructions.

Common Pitfalls and FAQs

  • Infinite Loading State OR Query failed: bucket not found OR Query failed: parsing error
    • No data received from the database. Be sure you are using the right bucket in your CB_BUCKET environment variable, a _default scope, and a collection named profile.
  • 504 Gateway Timeout after deploying
    • This error usually occurs when the application cannot reach the database. Ensure that the environment variables are correct, IP addresses are allowed, and the Database User credentials match those in the environment variables.
    • Check to ensure your Database wasn't deleted.

Live Demo

https://couchbase-nextjs-quickstart.vercel.app/

Tech Stack

Run the Code Locally

Prerequisites

To run this project locally, you will need:

  • A Couchbase Capella database or Couchbase 7+ database running locally
  • Node.js & NPM
  • Next.js
  • Code Editor

Get Started

Clone the source code:

git clone https://github.com/couchbase-examples/nextjs-quickstart.git

Install required dependencies:

npm install

If you are using Capella, you'll have to manually create a bucket named user_profile and a collection named profile. See the documentation on managing buckets and creating a collection for more information. Note that this collection should be created on the _default scope.

Update environment variables appropriately

We've included a .env.local.example file with blank values for you to copy into a file called .env.local and fill in the values. We've also included a .env.default file for testing and running in GitPod. In most cases, you can ignore the default config file.

  • CB_USERNAME - The username of an authorized user on your database. Follow these instructions to create database credentials on Capella.
  • CB_PASSWORD - The password that corresponds to the user specified above.
  • CB_CONNECT_STRING - The Couchbase connection string. Use the connection string specified on the 'Connect' tab within Capella (formatted like couchbases://cb.<xxxxxx>.cloud.couchbase.com) or couchbase://localhost for a local/Docker database.
  • CB_BUCKET - The bucket you'd like to connect to. Set this to user_profiles for this template.

Set up and Run The Application

If you have Couchbase running locally, we can create the bucket and collection by running the following command:

npm run init-db:local

If you'd like to add the sample data, run:

npm run load-sample-data

Note: this will also attempt to create a profile collection.

Extra Step for Capella Databases: if you've manually set up your bucket and collection, you'll need to create the necessary indices as well. To accomplish this, run:

npm run build-indexes

This is because the index creation code is contained within the database initialization script, which we don't use for Capella databases.

Now we're ready to run our application:

npm run dev

If everything is configured properly, you should be able to navigate to localhost:3000 to see the example application. For troubleshooting and additional setup instructions please refer to the NextJS_README.md included in the with-couchbase starter.

Sample Data

  • We've included a MOCK_DATA.json file containing 15 documents with various mocked user data. The build step will automatically load the sample data, but you may want to also load it manually for local testing. Use npm run load-sample-data to insert the documents to your database. Be sure your local environment variables are set correctly!
  • This file can also be imported into Capella manually.
  • You can also add your own profile data to the database manually by clicking the + icon in the UI.

Notes About the Quickstart Code

  • We've included a .env.default file which is used for testing and gitpod instances of the project to ensure smooth setup in these environments.
  • The build step is set up to not set a specific .env file and instead use the variables in the system environment. This is to ensure that the application can be deployed to Vercel properly, but can cause issues when trying to build locally.
    • If you need to pass in an environment file, you can adjust the build script to use the scripts that are not postfixed with :no-env in package.json.
  • In the completed quickstart code, fetch URLs use a dynamic origin variable instead of hard coding http://localhost:3000 to ensure requests work when running in other environments.
  • NOTE FOR CAPELLA DATABASES: The database initialization code currently only works with local databases. If you are using Capella, you'll need to manually create a bucket called user_profile and then within that buckets default scope, a collection called profile. See here for more info on managing buckets in Capella.. After bucket and collection creation, you can use the index creation command: npm run build-indexes. Running npm run init-db:local will also work to create the required indices. The bucket and collection creation steps will fail with ECONNREFUSED but it will still be able to create the index on your Capella database.

Running The Tests

A suite of integration tests has been included, and can be run by first setting up the database:

npm run init-db:default

and then using the npm test command.

Try it in Your Browser

Run with GitPod

Try it now!