kennyyuen/next-auth-typescript-example

An example project that shows how to use NextAuth with TypeScript

We have migrated the primary nextauthjs/next-auth-example repository to TypeScript and will be using that as our primary example repository going forward. This repository is deprecated and will most likely archived in the future.

NextAuth.js Typescript Example App

Open Source. Full Stack. Own Your Data.

Overview

This is an example of how to use the NextAuth.js library to add authentication to a Next.js application with Typescript.

Check out the TypeScript documentation.

This example application can be found under next-auth-typescript-example.vercel.app

About NextAuth.js

NextAuth.js is an easy to implement, full-stack (client/server) open source authentication library designed for Next.js and Serverless.

Go to next-auth.js.org for more information and documentation.

NextAuth.js is not associated with Vercel or Next.js.

Getting Started

1. Clone the repository and install dependancies

git clone https://github.com/nextauthjs/next-auth-typescript-example.git
cd next-auth-typescript-example
npm install

2. Configure your local environment

Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Add details for one or more providers (e.g. Google, Twitter, GitHub, Email, etc).

Database

A database is needed to persist user accounts and to support email sign in. However, you can still use NextAuth.js for authentication without a database by using OAuth for authentication. If you do not specify a database, JSON Web Tokens will be enabled by default.

You can skip configuring a database and come back to it later if you want.

For more information about setting up a database, please check out the following links:

• Docs: next-auth.js.org/adapters/overview
• Adapters Repo: nextauthjs/adapters

3. Configure Authentication Providers

• Review and update options in pages/api/auth/[...nextauth].js as needed.

• When setting up OAuth, in the developer admin page for each of your OAuth services, you should configure the callback URL to use a callback path of {server}/api/auth/callback/{provider}.

  e.g. For Google OAuth you would use: http://localhost:3000/api/auth/callback/google

  A list of configured providers and their callback URLs is available from the endpoint /api/auth/providers. You can find more information at https://next-auth.js.org/configuration/providers/oauth

• You can also choose to specify an SMTP server for passwordless sign in via email.

4. Start the application

To run your site locally, use:

npm run dev

To run it it production mode, use:

npm build
npm start

5. Preparing for Production

You must set the NEXTAUTH_URL environment variable with the URL of your site, before deploying to production.

e.g. in your .env.local file - NEXTAUTH_URL=https://example.com

To do this with Vercel, you can use the Vercel project dashboard or their cli with the vc env command:

vc env add NEXTAUTH_URL production

Do not forget to set the environment variables for the Client ID and Client Secret values for all your configured authentication providers in your hosting providers dashboard, i.e. with Vercel as described above.

Acknowledgements

Thanks to Vercel sponsoring this project by allowing it to be deployed for free for the entire NextAuth.js Team

License

ISC