History

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	Update authentication examples (#19330 )	2020-12-29 12:43:47 -05:00
pages	chore: replace deprecated String.prototype.substr() (#35421 )	2022-03-24 17:49:38 -04:00
public	Add example with Magic authentication (#11810 )	2020-04-22 18:15:12 -05:00
.env.local.example	Update authentication examples (#19330 )	2020-12-29 12:43:47 -05:00
.gitignore	Add .yarn/install-state.gz to .gitignore (#56637 )	2023-10-18 16:34:48 +00:00
package.json	chore(examples): bump dependency versions (#55899 )	2023-09-25 16:31:49 +00:00
README.md	update example Deploy button URLs (#48842 )	2023-04-26 13:31:44 -04:00

README.md

Magic Example

This example shows how to use Magic with Next.js. The example features cookie-based, passwordless authentication with email-based magic links.

The example shows how to do a login and logout; and to get the user info using a hook with SWR.

A DB is not included. But you can add any DB you like!.

The login cookie is httpOnly, meaning it can only be accessed by the API, and it's encrypted using @hapi/iron for more security.

Deploy your own

Once you have access to the environment variables you'll need, deploy the example using Vercel:

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-magic with-magic-app

yarn create next-app --example with-magic with-magic-app

pnpm create next-app --example with-magic with-magic-app

Configuration

Next, copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then set each variable on .env.local:

NEXT_PUBLIC_MAGIC_PUBLISHABLE_KEY should look like pk_test_abc or pk_live_ABC
MAGIC_SECRET_KEY should look like sk_test_ABC or sk_live_ABC
TOKEN_SECRET should be a string with at least 32 characters

Now, run Next.js in development mode

npm run dev
# or
yarn dev

Your app should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.

Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

Deploy from Our Template

Alternatively, you can deploy using our template by clicking on the Deploy button below.