https://github.com/clerk/clerk-nextjs-pages-quickstart
The official companion repo for Clerk's Next.js Quickstart using the pages router
https://github.com/clerk/clerk-nextjs-pages-quickstart
auth authentication clerk nextjs pages-dir react
Last synced: 7 months ago
JSON representation
The official companion repo for Clerk's Next.js Quickstart using the pages router
- Host: GitHub
- URL: https://github.com/clerk/clerk-nextjs-pages-quickstart
- Owner: clerk
- Created: 2023-10-25T02:28:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T01:24:42.000Z (about 1 year ago)
- Last Synced: 2024-07-24T02:16:41.478Z (about 1 year ago)
- Topics: auth, authentication, clerk, nextjs, pages-dir, react
- Language: TypeScript
- Homepage:
- Size: 565 KB
- Stars: 19
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Clerk and Next.js Pages Router Quickstart
## Introduction
Clerk is a developer-first authentication and user management solution. It provides pre-built React components and hooks for sign-in, sign-up, user profile, and organization management. Clerk is designed to be easy to use and customize, and can be dropped into any React or Next.js application.
After following the quickstart you'll have learned how to:
- Install `@clerk/nextjs`
- Set your Clerk API keys
- Add Clerk's middleware
- Add `` and Clerk components
## Deploy
Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fclerk%2Fclerk-nextjs-pages-quickstart&env=NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY,CLERK_SECRET_KEY&envDescription=Clerk%20API%20keys&envLink=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Fnextjs&redirect-url=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Fnextjs)
## Running the template
```bash
git clone https://github.com/clerk/clerk-nextjs-pages-quickstart
```
To run the example locally, you need to:
1. Sign up for a Clerk account at [https://clerk.com](https://dashboard.clerk.com/sign-up?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-nextjs-pages-quickstart).
2. Go to the [Clerk dashboard](https://dashboard.clerk.com?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-nextjs-pages-quickstart) and create an application.
3. Set the required Clerk environment variables as shown in [the example `env.local.example` file](./.env.local.example).
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.com/docs/quickstarts/nextjs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-nextjs-pages-quickstart)
- [Clerk Documentation](https://clerk.com/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=clerk-nextjs-pages-quickstart)
- [Next.js Documentation](https://nextjs.org/docs)
## Found an issue?
If you have found an issue with the quickstart, please create an [issue](https://github.com/clerk/clerk-nextjs-pages-quickstart/issues).
If it's a quick fix, such as a misspelled word or a broken link, feel free to skip creating an issue.
Go ahead and create a [pull request](https://github.com/clerk/clerk-nextjs-pages-quickstart/pulls) with the solution. :rocket:
## Want to leave feedback?
Feel free to create an [issue](https://github.com/clerk/clerk-nextjs-pages-quickstart/issues) with the **feedback** label. Our team will take a look at it and get back to you as soon as we can!
## Connect with us
You can discuss ideas, ask questions, and meet others from the community in our [Discord](https://discord.com/invite/b5rXHjAg7A).
If you prefer, you can also find support through our [Twitter](https://twitter.com/ClerkDev), or you can [email](mailto:support@clerk.dev) us!