https://github.com/clerk/clerk-nextjs-starter

Official starter repo for Clerk and Next.js
https://github.com/clerk/clerk-nextjs-starter

authentication clerk nextjs react

Last synced: 4 months ago
JSON representation

Official starter repo for Clerk and Next.js

• Host: GitHub
• URL: https://github.com/clerk/clerk-nextjs-starter
• Owner: clerk
• Archived: true
• Created: 2021-01-26T21:57:29.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-13T12:55:55.000Z (almost 2 years ago)
• Last Synced: 2024-09-21T01:23:20.975Z (5 months ago)
• Topics: authentication, clerk, nextjs, react
• Language: JavaScript
• Homepage: https://clerk-nextjs-example.vercel.app
• Size: 428 KB
• Stars: 114
• Watchers: 3
• Forks: 28
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

    

      

      

    

  

  




# Clerk Next.js Starter

This example shows how to use [Clerk](https://www.clerk.dev/?utm_source=github&utm_medium=starter_repos&utm_campaign=nextjs_starter) with Next.js. The example Next.js application features adding sign up, sign in, profile management, and an authenticated API route.

[![chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://discord.com/invite/b5rXHjAg7A)

[![documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://docs.clerk.dev)

[![twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev)

---

**Clerk is Hiring!**

Would you like to work on Open Source software and help maintain this repository? [Apply today!](https://apply.workable.com/clerk-dev/)

---

## Demo

A hosted demo of this example is available at [clerk-nextjs-example.vercel.app](https://clerk-nextjs-example.vercel.app/)

### Deploy your own

Deploy the example directly from GitHub using [Vercel](https://vercel.com):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/clerkinc/clerk-nextjs-starter&integration-ids=oac_7uYNbc9CdDAZmNqbt3LEkO3a)

## Running the starter

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:

```bash

npx create-next-app --example https://github.com/clerkinc/clerk-nextjs-starter

# or

yarn create next-app --example https://github.com/clerkinc/clerk-nextjs-starter

```

To run the example locally you need to:

1. Sign up for a Clerk account at https://clerk.dev.

2. Go to [Clerk's dashboard](https://dashboard.clerk.dev/?utm_source=github&utm_medium=starter_repos&utm_campaign=nextjs_starter) and create an application.

3. Set the required Clerk environment variables as shown in [the example env file](./.env.local.sample).

4. `npm install` the required dependencies.

5. `npm run dev` to launch the development server.

## Learn more

To learn more about Clerk and Next.js, check out the following resources:

- [Quickstart: Get started with Next.js and Clerk](https://clerk.dev/docs/quickstarts/get-started-with-nextjs?utm_source=github&utm_medium=starter_repos&utm_campaign=nextjs_starter)

- [Clerk Documentation](https://clerk.dev/docs?utm_source=github&utm_medium=starter_repos&utm_campaign=nextjs_starter)

- [Next.js Documentation](https://nextjs.org/docs)

## Contact

If you need support or have anything you would like to ask, please reach out in our [Discord channel](https://discord.com/invite/b5rXHjAg7A). We'd love to chat!