rsnext/examples/with-next-auth

NextAuth.js Example

Next.js example with next-auth, an open source, easy to use, and secure by default authentication library.

How to use

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, you'll need to fill at least one of the authentication providers by adding the required secrets for it, be that in the form of OAuth keys/secrets from a provider (Google, Twitter, etc.) or an SMTP connection string to enable email authentication.

More details about the providers can be found here, and for a more complete introduction to next-auth check out their introduction guide

It is vital that you know the deployment URL and define it in the environment file.

Using create-next-app

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

npx create-next-app --example next-auth with-next-auth-app
# or
yarn create next-app --example next-auth with-next-auth-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/next-auth
cd next-auth

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).

Note: For production you need to know in advance the domain (deployment URL) of your application, as it would be required for OAuth to work, once you have it set it to the VERCEL_URL environment variable under the settings of your Vercel project.