66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
# Example app utilizing cookie-based authentication
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Download [`create-next-app`](https://github.com/segmentio/create-next-app) to bootstrap the example:
|
|
|
|
```
|
|
npm i -g create-next-app
|
|
create-next-app --example with-cookie-auth with-cookie-auth-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example [or clone the repo](https://github.com/zeit/next.js):
|
|
|
|
```bash
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-cookie-auth
|
|
cd with-cookie-auth
|
|
```
|
|
|
|
### Run locally
|
|
|
|
The repository is setup as a [monorepo](https://zeit.co/examples/monorepo/) so you can deploy it easily running `now` inside the project folder. However, you can't run it the same way locally (yet).
|
|
|
|
These files make it easier to run the application locally and aren't needed for production:
|
|
|
|
- `/api/index.js` runs the API server on port `3001` and imports the `login` and `profile` microservices.
|
|
- `/www/server.js` runs the Next.js app with a custom server proxying the authentication requests to the API server. We use this so we don't modify the logic on the application and we don't have to deal with CORS if we use domains while testing.
|
|
|
|
Install and run the API server:
|
|
|
|
```bash
|
|
cd api
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Then run the Next.js app:
|
|
|
|
```bash
|
|
cd ../www
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### Deploy
|
|
|
|
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))
|
|
|
|
```bash
|
|
now
|
|
```
|
|
|
|
## The idea behind the example
|
|
|
|
In this example, we authenticate users and store a token in a cookie. The example only shows how the user session works, keeping a user logged in between pages.
|
|
|
|
This example is backend agnostic and uses [isomorphic-unfetch](https://www.npmjs.com/package/isomorphic-unfetch) to do the API calls on the client and the server.
|
|
|
|
The repo includes a minimal passwordless backend built with [Micro](https://www.npmjs.com/package/micro) that logs the user in with a GitHub username and saves the user id from the API call as token.
|
|
|
|
Session is syncronized across tabs. If you logout your session gets logged out on all the windows as well. We use the HOC `withAuthSync` for this.
|
|
|
|
The helper function `auth` helps to retrieve the token across pages and redirects the user if not token was found.
|