rsnext/examples/with-iron-session/README.md
JTaylor0196 f7baa56792
update example Deploy button URLs (#48842)
### What?
Updates Deploy button URLs for all listed examples here:
https://github.com/vercel/next.js/tree/canary/examples

### Why?
The Deploy URLs are currently broken and result in a failed clone
attempt on Vercel.

### How?
The URLs have been changed from https://vercel.com/new/git/external?… to
-> https://vercel.com/new/clone?…
(Last updated
[here](8eaabe2fb0)
in 2021)
2023-04-26 13:31:44 -04:00

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 useUser hook and the swr.
  • 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

Deploy with Vercel

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
yarn create next-app --example with-iron-session with-iron-session-app
pnpm create next-app --example with-iron-session with-iron-session-app

Deploy it to the cloud with Vercel (Documentation).