https://github.com/nextauthjs/next-auth-refresh-token-example
NextAuth.js Refresh Token Example
https://github.com/nextauthjs/next-auth-refresh-token-example
Last synced: 10 months ago
JSON representation
NextAuth.js Refresh Token Example
- Host: GitHub
- URL: https://github.com/nextauthjs/next-auth-refresh-token-example
- Owner: nextauthjs
- License: isc
- Created: 2021-11-23T22:27:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-11T07:07:40.000Z (about 3 years ago)
- Last Synced: 2025-04-07T02:37:57.171Z (about 1 year ago)
- Language: JavaScript
- Size: 30.3 KB
- Stars: 108
- Watchers: 4
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NextAuth.js Refresh Token Example
Open Source. Full Stack. Own Your Data.
## Overview
NextAuth.js is a complete open source authentication solution for [Next.js](http://nextjs.org/) applications.
This is an example application which shows how `next-auth` can be used to refresh a JWT `accessToken` via the `refreshToken`.
Thanks to [`@agusterodin`](https://github.com/agusterodin) for this usage example! See: [next-auth/docs#117](https://github.com/nextauthjs/docs/pull/117).
### About NextAuth.js
NextAuth.js is an easy to implement, full-stack (client/server) open source authentication library designed for [Next.js](https://nextjs.org) and [Serverless](https://vercel.com).
Go to [next-auth.js.org](https://next-auth.js.org) for more information and documentation.
> _NextAuth.js is not officially associated with Vercel or Next.js._
## Getting Started
### 1. Clone the repository and install dependencies
```
git clone https://github.com/nextauthjs/next-auth-refresh-token-example.git
cd next-auth-refresh-token-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).
### 3. Configure Authentication Providers
1. Review and update options in `pages/api/auth/[...nextauth].js` as needed.
2. 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
3. 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 in production mode, use:
```
npm run build
npm run 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](https://vercel.com/dashboard) or their cli via 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