-
Notifications
You must be signed in to change notification settings - Fork 27.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add 'with-next-auth' example (#14530)
I accidentally deleted the repo the original PR was based upon haha. Anyway, the code was still on my computer so here's a new PR with the same content. I addressed the latest comments from @lfades in the old PR (#14180) I also updated `next-auth` to `2.1.0` and updated the `<Provider />` component in `_app.js` that needed updating since the latest release. Let me know if I missed anything else, otherwise I think this should be good to go 👍
- Loading branch information
Showing
13 changed files
with
428 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
SITE=http://localhost:3000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
GOOGLE_ID= | ||
GOOGLE_SECRET= | ||
FACEBOOK_ID= | ||
FACEBOOK_SECRET= | ||
TWITTER_ID= | ||
TWITTER_SECRET= | ||
GITHUB_ID= | ||
GITHUB_SECRET= | ||
EMAIL_SERVER=smtp://username:[email protected]:587 | ||
EMAIL_FROM=NextAuth <[email protected]> | ||
DATABASE_URL=sqlite://localhost/:memory:?synchronize=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# NextAuth.js Example | ||
|
||
Next.js example with [`next-auth`](https://github.com/iaincollins/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): | ||
|
||
```bash | ||
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](https://next-auth.js.org/configuration/providers), and for a more complete introduction to `next-auth` check out their [introduction guide](https://next-auth.js.org/getting-started/introduction) | ||
|
||
It is vital that you know the deployment URL and define it in the environment file. | ||
|
||
### Using `create-next-app` | ||
|
||
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example: | ||
|
||
```bash | ||
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: | ||
|
||
```bash | ||
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: | ||
|
||
```bash | ||
npm install | ||
npm run dev | ||
# or | ||
yarn | ||
yarn dev | ||
``` | ||
|
||
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). | ||
|
||
**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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import styles from './footer.module.css' | ||
|
||
const Footer = () => ( | ||
<div className={styles.footer}> | ||
<hr /> | ||
<ul className={styles.navigation}> | ||
<li className={styles.navigationItem}> | ||
<a href="https://github.com/iaincollins/next-auth-example">Source</a> | ||
</li> | ||
<li className={styles.navigationItem}> | ||
<a href="https://next-auth.js.org">Documentation</a> | ||
</li> | ||
</ul> | ||
</div> | ||
) | ||
|
||
export default Footer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
.footer { | ||
margin-top: 2rem; | ||
} | ||
|
||
.navigation { | ||
margin-bottom: 2rem; | ||
padding: 0; | ||
list-style: none; | ||
} | ||
|
||
.navigationItem { | ||
display: inline-block; | ||
margin-right: 1rem; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
import { signin, signout, useSession } from 'next-auth/client' | ||
import styles from './nav.module.css' | ||
|
||
/** | ||
* The approach used in this component shows how to built a sign in and sign out | ||
* component that works on pages which support both client and server side | ||
* rendering, and avoids any flash incorrect content on initial page load. | ||
**/ | ||
const Nav = () => { | ||
const [session, loading] = useSession() | ||
|
||
return ( | ||
<nav> | ||
<noscript> | ||
<style>{`.nojs-show { opacity: 1; top: 0; }`}</style> | ||
</noscript> | ||
<p | ||
className={`nojs-show ${ | ||
!session && loading ? styles.loading : styles.loaded | ||
}`} | ||
> | ||
{!session && ( | ||
<> | ||
<span className={styles.notSignedIn}>Not signed in</span> | ||
<a | ||
href={`/api/auth/signin`} | ||
onClick={(e) => { | ||
e.preventDefault() | ||
signin() | ||
}} | ||
> | ||
<button className={styles.signinButton}>Sign in</button> | ||
</a> | ||
</> | ||
)} | ||
{session && ( | ||
<> | ||
<span | ||
style={{ backgroundImage: `url(${session.user.image})` }} | ||
className={styles.avatar} | ||
/> | ||
<span className={styles.signedIn}> | ||
Signed in as <strong>{session.user.email}</strong> | ||
</span> | ||
<a | ||
href={`/api/auth/signout`} | ||
onClick={(e) => { | ||
e.preventDefault() | ||
signout() | ||
}} | ||
> | ||
<button className={styles.signoutButton}>Sign out</button> | ||
</a> | ||
</> | ||
)} | ||
</p> | ||
</nav> | ||
) | ||
} | ||
|
||
export default Nav |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
.loading, | ||
.loaded { | ||
position: relative; | ||
top: 0; | ||
opacity: 1; | ||
overflow: auto; | ||
border-radius: 0 0 0.6rem 0.6rem; | ||
padding: 0.4rem 0.8rem; | ||
margin: 0; | ||
background-color: #f5f5f5; | ||
transition: all 0.2s ease-in-out; | ||
} | ||
|
||
.loading { | ||
top: -2rem; | ||
opacity: 0; | ||
} | ||
|
||
.signedIn, | ||
.notSignedIn { | ||
position: absolute; | ||
padding: 0.6rem 0 0.4rem 0; | ||
left: 1rem; | ||
right: 7rem; | ||
white-space: nowrap; | ||
text-overflow: ellipsis; | ||
overflow: hidden; | ||
display: inherit; | ||
z-index: 1; | ||
} | ||
|
||
.signedIn { | ||
left: 3.8rem; | ||
} | ||
|
||
.avatar { | ||
border-radius: 2rem; | ||
float: left; | ||
height: 2.2rem; | ||
width: 2.2rem; | ||
background-color: white; | ||
background-size: cover; | ||
border: 2px solid #ddd; | ||
} | ||
|
||
.signinButton, | ||
.signoutButton { | ||
float: right; | ||
margin-right: -0.4rem; | ||
font-weight: 500; | ||
background-color: #1eb1fc; | ||
color: #fff; | ||
border: 1px solid #1eb1fc; | ||
border-radius: 2rem; | ||
cursor: pointer; | ||
font-size: 1rem; | ||
line-height: 1rem; | ||
padding: 0.5rem 1rem; | ||
position: relative; | ||
z-index: 10; | ||
} | ||
|
||
.signinButton:hover { | ||
background-color: #1b9fe2; | ||
border-color: #1b9fe2; | ||
color: #fff; | ||
} | ||
|
||
.signoutButton { | ||
background-color: #fff; | ||
border-color: #bbb; | ||
color: #555; | ||
} | ||
|
||
.signoutButton:hover { | ||
background-color: #fff; | ||
border-color: #aaa; | ||
color: #333; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"name": "next-auth-example", | ||
"version": "1.0.0", | ||
"scripts": { | ||
"dev": "next", | ||
"build": "next build", | ||
"start": "next start" | ||
}, | ||
"license": "ISC", | ||
"dependencies": { | ||
"next": "latest", | ||
"next-auth": "^2.1.0", | ||
"react": "^16.13.1", | ||
"react-dom": "^16.13.1", | ||
"sqlite3": "^4.2.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import { Provider } from 'next-auth/client' | ||
import '../styles.css' | ||
|
||
const App = ({ Component, pageProps }) => { | ||
const { session } = pageProps | ||
return ( | ||
<Provider options={{ site: process.env.SITE }} session={session}> | ||
<Component {...pageProps} /> | ||
</Provider> | ||
) | ||
} | ||
|
||
export default App |
105 changes: 105 additions & 0 deletions
105
examples/with-next-auth/pages/api/auth/[...nextauth].js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
import NextAuth from 'next-auth' | ||
import Providers from 'next-auth/providers' | ||
|
||
const options = { | ||
site: process.env.VERCEL_URL, | ||
providers: [ | ||
Providers.Email({ | ||
// SMTP connection string or nodemailer configuration object https://nodemailer.com/ | ||
server: process.env.EMAIL_SERVER, | ||
// Email services often only allow sending email from a valid/verified address | ||
from: process.env.EMAIL_FROM, | ||
}), | ||
// When configuring oAuth providers make sure you enabling requesting | ||
// permission to get the users email address (required to sign in) | ||
Providers.Google({ | ||
clientId: process.env.GOOGLE_ID, | ||
clientSecret: process.env.GOOGLE_SECRET, | ||
}), | ||
Providers.Facebook({ | ||
clientId: process.env.FACEBOOK_ID, | ||
clientSecret: process.env.FACEBOOK_SECRET, | ||
}), | ||
Providers.Twitter({ | ||
clientId: process.env.TWITTER_ID, | ||
clientSecret: process.env.TWITTER_SECRET, | ||
}), | ||
Providers.GitHub({ | ||
clientId: process.env.GITHUB_ID, | ||
clientSecret: process.env.GITHUB_SECRET, | ||
}), | ||
], | ||
// The 'database' option should be a connection string or TypeORM | ||
// configuration object https://typeorm.io/#/connection-options | ||
// | ||
// Notes: | ||
// * You need to install an appropriate node_module for your database! | ||
// * The email sign in provider requires a database but OAuth providers do not | ||
database: process.env.DATABASE_URL, | ||
|
||
session: { | ||
// Use JSON Web Tokens for session instead of database sessions. | ||
// This option can be used with or without a database for users/accounts. | ||
// Note: `jwt` is automatically set to `true` if no database is specified. | ||
// jwt: false, | ||
// Seconds - How long until an idle session expires and is no longer valid. | ||
// maxAge: 30 * 24 * 60 * 60, // 30 days | ||
// Seconds - Throttle how frequently to write to database to extend a session. | ||
// Use it to limit write operations. Set to 0 to always update the database. | ||
// Note: This option is ignored if using JSON Web Tokens | ||
// updateAge: 24 * 60 * 60, // 24 hours | ||
// Easily add custom properties to response from `/api/auth/session`. | ||
// Note: This should not return any sensitive information. | ||
/* | ||
get: async (session) => { | ||
session.customSessionProperty = "ABC123" | ||
return session | ||
} | ||
*/ | ||
}, | ||
|
||
// JSON Web Token options | ||
jwt: { | ||
// secret: 'my-secret-123', // Recommended (but auto-generated if not specified) | ||
// Custom encode/decode functions for signing + encryption can be specified. | ||
// if you want to override what is in the JWT or how it is signed. | ||
// encode: async ({ secret, key, token, maxAge }) => {}, | ||
// decode: async ({ secret, key, token, maxAge }) => {}, | ||
// Easily add custom to the JWT. It is updated every time it is accessed. | ||
// This is encrypted and signed by default and may contain sensitive information | ||
// as long as a reasonable secret is defined. | ||
/* | ||
set: async (token) => { | ||
token.customJwtProperty = "ABC123" | ||
return token | ||
} | ||
*/ | ||
}, | ||
|
||
// Control which users / accounts can sign in | ||
// You can use this option in conjuction with OAuth and JWT to control which | ||
// accounts can sign in without having to use a database. | ||
allowSignin: async (user, account) => { | ||
// Return true if user / account is allowed to sign in. | ||
// Return false to display an access denied message. | ||
return true | ||
}, | ||
|
||
// You can define custom pages to override the built-in pages | ||
// The routes shown here are the default URLs that will be used. | ||
pages: { | ||
// signin: '/api/auth/signin', // Displays signin buttons | ||
// signout: '/api/auth/signout', // Displays form with sign out button | ||
// error: '/api/auth/error', // Error code passed in query string as ?error= | ||
// verifyRequest: '/api/auth/verify-request', // Used for check email page | ||
// newUser: null // If set, new users will be directed here on first sign in | ||
}, | ||
|
||
// Additional options | ||
// secret: 'abcdef123456789' // Recommended (but auto-generated if not specified) | ||
// debug: true, // Use this option to enable debug messages in the console | ||
} | ||
|
||
const Auth = (req, res) => NextAuth(req, res, options) | ||
|
||
export default Auth |
Oops, something went wrong.