3e178bb801
## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint` - [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) Co-authored-by: Steven <steven@ceriously.com>
2.5 KiB
2.5 KiB
Example application using iron-session
👀 Online demo at https://iron-session-example.vercel.app
This example creates an authentication system that uses a signed and encrypted cookie to store session data. It relies on iron-session.
It uses current best practices for authentication in the Next.js ecosystem and replicates parts of how the Vercel dashboard is built.
Features of the example:
- API Routes and getServerSideProps examples.
- The logged in status is synchronized between browser windows/tabs using
useUserhook and theswr. - The layout is based on the user's logged-in/out status.
- The session data is signed and encrypted in a cookie (this is done automatically by
iron-session).
iron-session also provides:
- An Express middleware, which can be used in any Node.js HTTP framework.
- Multiple encryption keys (passwords) to allow for seamless updates or just password rotation.
- Full TypeScript support, including session data.
Deploy your own
Deploy the example using Vercel or preview live with StackBlitz
How to use
Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-iron-session with-iron-session-app
# or
yarn create next-app --example with-iron-session with-iron-session-app
# or
pnpm create next-app -- --example with-iron-session with-iron-session-app
Deploy it to the cloud with Vercel (Documentation).