rsnext/examples/with-iron-session
Steven 4466ba436b
chore(examples): use default prettier for examples/templates (#60530)
## Description
This PR ensures that the default prettier config is used for examples
and templates.

This config is compatible with `prettier@3` as well (upgrading prettier
is bigger change that can be a future PR).

## Changes
- Updated `.prettierrc.json` in root with `"trailingComma": "es5"` (will
be needed upgrading to prettier@3)
- Added `examples/.prettierrc.json` with default config (this will
change every example)
- Added `packages/create-next-app/templates/.prettierrc.json` with
default config (this will change every template)

## Related

- Fixes #54402
- Closes #54409
2024-01-11 16:01:44 -07:00
..
components chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
lib chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
pages chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
public docs(examples): Update with-iron-session to latest iron-session API (#30956) 2021-11-09 09:30:15 -06:00
.env.development examples(iron-session): update fetch, env, UI, deps, and docs (#13756) 2020-06-04 13:12:52 -04:00
.env.production examples(iron-session): update fetch, env, UI, deps, and docs (#13756) 2020-06-04 13:12:52 -04:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
next.config.js chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
package.json examples: Bump SWR to v2.0.0 (#44790) 2023-01-12 09:36:29 -08:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tsconfig.json docs(examples): Update with-iron-session to latest iron-session API (#30956) 2021-11-09 09:30:15 -06:00
vercel.json Update instances of Now to Vercel where applicable (#13760) 2020-06-04 14:57:17 +00:00

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).