* add userbase example

* update readme and add now.json with build.env

* update deploy button import path for testing

* update readme

* update readme with canary tree path for deploy button

* remove prepopulated test username + password

* Apply lint-fix

* add deployed demo link

* remove merge conflict arrows

* fix lint errors

* run yarn lint-fix

* add .env.example and update readme with config steps

* add dotenv and update next.config.js

Co-authored-by: Matthew Sweeney <mail@msweeneydev.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>

2020-04-23 19:56:42 -05:00

2.9 KiB

Raw Blame History

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/zeit/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 Now CLI (Documentation).

Install Now CLI, log in to your account from the CLI, and run the following commands to add the environment variables. Replace <NEXT_EXAMPLE_CMS_DATOCMS_API_TOKEN> and <NEXT_EXAMPLE_CMS_DATOCMS_PREVIEW_SECRET> with the corresponding strings 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.

2.9 KiB Raw Blame History