History

leung018 66597be8a7 Add .yarn/install-state.gz to .gitignore (#56637 ) ### Reason for making this change https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again. In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited. ### Remaining work I apologize for only modifying one template initially to initiate the discussion first. If this change is agreed upon, it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.		2023-10-18 16:34:48 +00:00
..
components	Update dependencies of all CMS examples. (#27001 )	2021-07-09 14:43:56 +02:00
pages	Update to modern env handling for userbase example (#13774 )	2020-06-05 00:50:56 +00:00
styles	Add userbase example (#12150 )	2020-04-23 19:56:42 -05:00
.env.local.example	Update to modern env handling for userbase example (#13774 )	2020-06-05 00:50:56 +00:00
.gitignore	Add .yarn/install-state.gz to .gitignore (#56637 )	2023-10-18 16:34:48 +00:00
package.json	Update Examples to use React 18 (#42027 )	2022-10-28 17:43:20 +00:00
postcss.config.js	Update dependencies of all CMS examples. (#27001 )	2021-07-09 14:43:56 +02:00
README.md	update example Deploy button URLs (#48842 )	2023-04-26 13:31:44 -04:00
tailwind.config.js	[Docs] Add config types to all examples (#40083 )	2022-08-31 16:41:22 -05:00

README.md

Userbase Example

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

Deployed Demo: https://next-userbase.vercel.app

Deploy your own

Once you have access to the environment variables you'll need, deploy the example using Vercel:

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-userbase next-userbase-app
# or
yarn create next-app --example with-userbase next-userbase-app
# or
pnpm create next-app --example with-userbase next-userbase-app

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.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then set the variable on .env.local:

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

Your .env.local file should look like this:

NEXT_PUBLIC_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).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

Deploy from Our Template

Alternatively, you can deploy using our template by clicking on the Deploy button below.