README

Running the Playground

Standard:

pnpm dev

On changes to upstream monorepo packages:

pnpm update @clerk/chrome-extension && pnpm dev

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 Chrome Extension application.

After following the quickstart you'll have learned how to:

• Scaffold a new application using the Plasmo framework
• Install @clerk/chrome-extension
• Set your environment variables
• Add <ClerkProvider> to your application
• Create a header with Clerk components for users to sign in and out
• Configure a consistent CRX key
• Load your Chrome Extension into your Chromium-based browser
• Test your Chrome Extension

Running the template

git clone https://github.com/clerkinc/clerk-chrome-extension-quickstart

To run the example locally, you need to:

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

2. Go to the Clerk dashboard and create an application.

3. Set the required Clerk environment variables as shown in the example .env.development file.

4. Create a consistent CRX ID for your extension.

5. Set the public key are shown in the example .env.chrome file.

6. pnpm install the required dependencies.

7. pnpm dev to launch the development server.

Learn more

To learn more about Clerk and Chrome Extensions, check out the following resources:

• Quickstart: Get started with Chrome Extensions and Clerk

• Clerk Documentation

• Chrome Extensions

Found an issue or want to leave feedback

Feel free to create a support thread on our 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.

If you prefer, you can also find support through our Twitter, or you can email us!