rsnext/examples/with-iron-session
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
components Run next/link codemod for Next.js 13 on examples (#41913) 2022-10-30 21:00:45 +01:00
lib Updates Mozilla links to not include language preference (#55326) 2023-09-13 11:06:29 -05:00
pages Enable @typescript-eslint/no-use-before-define for examples dir (#39469) 2022-08-10 16:30:36 +00: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 docs(examples): Update with-iron-session to latest iron-session API (#30956) 2021-11-09 09:30:15 -06: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).