rsnext/examples/with-clerk/README.md
Marcos Bérgamo c3e5caf110
docs(examples): improve DX while copying command to create new project (#38410)
* docs(examples): improve DX while copy command to create new project

* chore: apply code review

Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00

2.1 KiB

Clerk and Next.js Example

This example shows how to use Clerk with Next.js. The example features adding sign up, sign in, profile management, and an authenticated API route to your Next.js application.

Demo

A hosted demo of this example is available at clerk-nextjs-example.vercel.app

Deploy your own

Deploy the example using Vercel:

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-clerk with-clerk-app
yarn create next-app --example with-clerk with-clerk-app
pnpm create next-app --example with-clerk with-clerk-app

To run the example locally you need to:

  1. Sign up at Clerk.dev.
  2. Go to Clerk's dashboard and create an application.
  3. Set the required Clerk environment variables from your Clerk project as shown at the example env file.
  4. yarn to install the required dependencies.
  5. yarn dev to launch the development server.

Learn More

To learn more about Clerk.dev and Next.js, take a look at the following resources: