Auth0 Next.js Starter

Auth0 Next.js SDK Sample Application

This sample demonstrates the integration of Auth0 Next.js SDK into a Next.js application created using create-next-app. The sample is a companion to the Auth0 Next.js SDK Quickstart.

This sample demonstrates the following use cases:

• Login
• Logout
• Showing the user profile
• Protecting client-side rendered pages
• Calling APIs

Project setup

Use npm to install the project dependencies:

1
npm install

Configuration

Create an API

For the External API page to work, you will need to create an API using the management dashboard. This will give you an API Identifier that you can use in the AUTH0_AUDIENCE environment variable below. Then you will need to add a permission named read:shows to your API. To get your app to ask for that permission, include it in the value of the AUTH0_SCOPE environment variable.

If you do not wish to use an API or observe the API call working, you should not specify the AUTH0_AUDIENCE and AUTH0_SCOPE values in the next steps.

Configure credentials

The project needs to be configured with your Auth0 Domain, Client ID and Client Secret for the authentication flow to work.

To do this, first copy .env.local.example into a new file in the same folder called .env.local, and replace the values with your own Auth0 application credentials (see more info about loading environmental variables in Next.js):

1
# A long secret value used to encrypt the session cookie
2
AUTH0_SECRET='LONG_RANDOM_VALUE'
3
# The base url of your application
4
APP_BASE_URL='http://localhost:3000'
5
# Your Auth0 tenant domain
6
AUTH0_DOMAIN='YOUR_AUTH0_DOMAIN.auth0.com'
7
# Your Auth0 application's Client ID
8
AUTH0_CLIENT_ID='YOUR_AUTH0_CLIENT_ID'
9
# Your Auth0 application's Client Secret
10
AUTH0_CLIENT_SECRET='YOUR_AUTH0_CLIENT_SECRET'
11
# Your Auth0 API's Identifier 
12
# OMIT if you do not want to use the API part of the sample
13
AUTH0_AUDIENCE='YOUR_AUTH0_API_IDENTIFIER'
14
# The permissions your app is asking for
15
# OMIT if you do not want to use the API part of the sample
16
AUTH0_SCOPE='openid profile email read:shows'

Note: Make sure you replace AUTH0_SECRET with your own secret (you can generate a suitable string using openssl rand -hex 32 on the command line).

Run the sample

Compile and hot-reload for development

This compiles and serves the Next.js app and starts the API server on port 3001.

1
npm run dev

Deployment

Compiles and minifies for production

1
npm run build

Docker build

To build and run the Docker image, run exec.sh, or exec.ps1 on Windows.

Run the unit tests

1
npm run test

Run the integration tests

1
npm run test:integration

What is Auth0?

Auth0 helps you to:

• Add authentication with multiple sources, either social identity providers such as Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce (amongst others), or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML Identity Provider.
• Add authentication through more traditional username/password databases.
• Add support for linking different user accounts with the same user.
• Support for generating signed JSON Web Tokens to call your APIs and flow the user identity securely.
• Analytics of how, when, and where users are logging in.
• Pull data from other sources and add it to the user profile through JavaScript rules.

Create a Free Auth0 Account

1. Go to Auth0 and click Sign Up.
2. Use Google, GitHub, or Microsoft Account to login.

Deploy to Vercel

Easily deploy to the template to Vercel with the button below.

Updating Allowed Callback URLs

When using custom domains for your Vercel deployment, you will need to add them to the Allowed Callback URLs. More details here.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.