f00ad581a1
Co-authored-by: Joe Haddad <joe.haddad@zeit.co> |
||
---|---|---|
.. | ||
components | ||
pages | ||
styles | ||
.env.local.example | ||
.gitignore | ||
package.json | ||
postcss.config.js | ||
README.md |
Userbase Example
This is an example of using Userbase in a Next.js project.
Deployed Demo: https://next-userbase.now.sh
Deploy your own
Once you have access to the environment variables you'll need, deploy the example using Vercel:
How to use
Using create-next-app
Execute create-next-app
with npm or Yarn 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
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.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.