Back to Next Js

Magic Example

examples/with-magic/README.md

16.2.53.5 KB
Original Source

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

How to use

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

bash
npx create-next-app --example with-magic with-magic-app
bash
yarn create next-app --example with-magic with-magic-app
bash
pnpm create next-app --example with-magic with-magic-app

Configuration

Login to the Magic Dashboard and get the keys of your application

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

bash
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

bash
npm run dev
# or
yarn dev
# or
pnpm 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.