rsnext/examples/with-iron-session
Aleksa Cukovic bcd8de3262
Add *.tsbuildinfo to .gitignore of examples that use typescript (#38005)
I added ` *.tsbuildinfo` to gitignores of examples that use typescript and don't already have it. By use typescript I mean have `tsconfig` somewhere in their directory tree. 

I used the following script to update the files:

```bash
#!/bin/bash

set -eou pipefail

cd examples
examples=`git ls-files . | grep tsconfig | xargs dirname | grep -v "/"`

for example in $examples; do
    if ! grep -q tsbuildinfo $example/.gitignore; then
        gitignore="$example/.gitignore"
        echo $gitignore
        tail -c1 $gitignore | read -r _ || echo >> $gitignore
        echo -e "\n# typescript\n*.tsbuildinfo" >> $gitignore
    fi
done
```
2022-06-26 11:17:44 +00:00
..
components docs(examples): Update with-iron-session to latest iron-session API (#30956) 2021-11-09 09:30:15 -06:00
lib docs(examples): add secure flag explanation to with-iron-session (#31896) 2021-11-28 18:35:39 -06:00
pages Fix a few ZEIT to Vercel, .now.sh to .vercel.app. (#34300) 2022-02-13 22:53:22 +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 *.tsbuildinfo to .gitignore of examples that use typescript (#38005) 2022-06-26 11:17:44 +00:00
next-env.d.ts Include submodules in exported type definition (#28316) 2021-11-26 14:46:56 +01: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 docs(examples): Update with-iron-session to latest iron-session API (#30956) 2021-11-09 09:30:15 -06:00
README.md Update pnpm create next-app for latest pnpm 6 and 7 (#37254) 2022-05-27 21:21:40 +00: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
# 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).