rsnext/examples/with-clerk/README.md
Colin Sidoti 713a5aa701
Use new @clerk/nextjs package in with-clerk example, update Next.js authentication docs (#28906)
* Update headings to clarify that we're describing. Add heading for Authentication API Routes

* Start adding API route examples

* Start adding API route examples

* Start adding API route examples

* Start adding API route examples

* auth: Replace clerk packages with @clerk/nextjs

* Add API authentication example to with-clerk

* Fix footer links

* Proofread, ensure consistency

* Update example's props to use new version

* Update example links

* Add rel tag to _blank link

* Obscure the authentication provider in the example

* Replace example

* Reset authentication docs, list Clerk as vendor

* Re-fix typo

* Change sample to example

* Add the example

* Update examples/with-clerk/package.json

Co-authored-by: Lee Robinson <me@leerob.io>

Co-authored-by: Peter Perlepes <p.perlepes@gmail.com>
Co-authored-by: Lee Robinson <me@leerob.io>
2021-09-17 10:54:34 -05:00

2 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 or Yarn to bootstrap the example:

npx create-next-app --example with-clerk with-clerk-app
# or
yarn 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: