rohanharikr / hello-nextjs-starter

Hellō Next.js Starter

Hellō Next.js Starter

This is a starter application for the Hellō Next.js SDK @hellocoop/nextjs

You can have this app running fully configured on localhost in a minute, and then deploy to Vercel fully configured a minute later.

See a deployed version at https://hello-nextjs-starter.vercel.app

To run locally, you will need:

• nodejs 18+
• git
• A GitHub account

1. Fork this repository to your GitHub account

https://github.com/hellocoop/hello-nextjs-starter/fork

2. Clone your fork to your local machine

How to clone a repository

• Click on the [ <> Code ▾ ] button above and copy the address of your forked repo to your clipboard.
• Open a terminal on your machine, type git clone, and then paste in the address you copied.

This will create a hello-nextjs-starter directory on your machine with the contents of this repo.

3. Install, configure, and run!

Run these commands to start running locally:

cd hello-nextjs-starter
npm install
npm run quickstart
npm run dev

Open http://localhost:3000 (assuming port 3000 was free)

4. Deploy to Vercel and open your deployment

You will need:

• A Vercel account linked to your GitHub account so it can access the repo you just created
• Vercel CLI that is logged into your Vercel account

These commands will install the Vercel CLI and login

npm install -g vercel
vercel login

These commands will configure, build, and deploy your repo to Vercel and then load the deployed site:

vercel link --yes
npm run config:vercel
DEPLOYMENT=$(vercel --yes)
npx open-cli $DEPLOYMENT

No other configuration needed at Vercel!

How Configuration Works

The Hellō Quickstart Web App created your application at Hellō and returned your client_id. You are able to use your app on your own machine immediately as http://localhost:* Redirect URIs are enabled for your development team by default.

You are able to access your app when deployed as we have enabled https://* Redirect URIs for members of your development team. The first time you login to your deployed app, the @hellocoop/nextjs package auto configures the redirect_uri, and on return you will be prompted to add the Redirect URI to your app at the Hello Developer Console. For development deployments, add to your Development Redirect URIs, for production or deployments you want others to access, add to your Production Redirect URIs.

---

Learn More

• Hellō Next.js SDK NOTE - the Next.js SDK API is under development and will change
• Hellō Quickstart
• Hellō Documentation