https://github.com/clerk/clerk-nuxt-quickstart
https://github.com/clerk/clerk-nuxt-quickstart
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/clerk/clerk-nuxt-quickstart
- Owner: clerk
- Created: 2024-11-19T22:39:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-09T22:03:56.000Z (about 1 year ago)
- Last Synced: 2025-05-09T23:19:29.011Z (about 1 year ago)
- Language: TypeScript
- Size: 1.06 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Clerk and Nuxt Quickstart
## Introduction
Clerk is a developer-first authentication and user management solution. It provides pre-built Nuxt components and composables 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 Nuxt application.
After following the quickstart, you'll have learned how to:
- Install `@clerk/nuxt`
- Set your Clerk API keys
- Configure `nuxt.config.ts`
- Create a header with Clerk components
- Protect your API routes
## 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-nuxt-quickstart&env=PUBLIC_CLERK_PUBLISHABLE_KEY,CLERK_SECRET_KEY&envDescription=Clerk%20API%20keys&envLink=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Fnuxt&redirect-url=https%3A%2F%2Fclerk.com%2Fdocs%2Fquickstart%2Fnuxt)
## Running the template
```bash
git clone https://github.com/clerk/clerk-nuxt-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=10-24-2023&utm_term=clerk-nuxt-app-quickstart).
2. Go to the [Clerk dashboard](https://dashboard.clerk.com?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-nuxt-quickstart) and create an application.
3. Set the required Clerk environment variables as shown in [the example `env` file](./.env.example).
4. `npm install` the required dependencies.
5. `npm run dev` to launch the development server.
## Learn more
To learn more about Clerk and Nuxt, check out the following resources:
- [Quickstart: Get started with Nuxt and Clerk](https://clerk.com/docs/quickstarts/nuxt?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-nuxt-quickstart)
- [Clerk Documentation](https://clerk.com/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-nuxt-quickstart)
- [Nuxt Documentation](https://nuxt.com/docs/getting-started/introduction)
## Found an issue or want to leave feedback
Feel free to create a support thread on our [Discord](https://clerk.com/discord). Our support team will be happy to assist you in the `#support` channel.
## 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!