rsnext/examples/with-userbase

Userbase Example

This is an example of using Userbase in a Next.js project.

Deployed Demo: https://next-userbase.now.sh

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:

npm init next-app --example with-userbase next-userbase-app
# or
yarn create next-app --example with-userbase next-userbase-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-userbase
cd with-userbase

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Configuration

Step 1. Create an account on Userbase

First, create an account on Userbase.

After creating an account, make note of your App ID which you'll be needing later.

Step 2. Setting up environment variables

Copy the .env.example file in this directory to .env (which will be ignored by Git):

cp .env.example .env

Then set the variable on .env:

• USERBASE_APP_ID should be the App ID from when you created your Userbase account.

Your .env file should look like this:

USERBASE_APP_ID=...

Step 3. Run Next.js in development mode

npm install
npm run dev

# or

yarn install
yarn dev

Your todo app should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.

Step 4. Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

To deploy on Vercel, you need to set the environment variables with Now Secrets using Vercel CLI (Documentation).

Install Vercel CLI, log in to your account from the CLI, and run the following command to add the environment variable. Replace <USERBASE_APP_ID> with the corresponding string in .env:

now secrets add userbase-app-id <USERBASE_APP_ID>

Then push the project to GitHub/GitLab/Bitbucket and import to Vercel to deploy.