Skip to content

The official companion repo for Clerk's JavaScript Quickstart

Notifications You must be signed in to change notification settings

clerk/clerk-javascript-quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clerk Logo for light background

Clerk JavaScript Quickstart

Downloads Discord Twitter

Clerk Hero Image

Introduction

Clerk is a developer-first authentication and user management solution. ClerkJS is our foundational JavaScript library for building user management and authentication. It enables you to register, sign in, verify, and manage users for your application using highly customizable flows.

After following the ClerkJS quickstart, you will have learned how to:

  • Add the ClerkJS SDK to your JavaScript application
  • Use Clerk components to allow users to sign in or out

Branches of this repository

To add the ClerkJS SDK to your JavaScript application, you have two options:

  1. Install the package using a package manager, like npm, yarn, or pnpm.
  2. Use the <script> tag to load the ClerkJS package from our CDN.

The branches of this repository represent the results of these implementation:

  • main: The result of following the JavaScript quickstart if you chose NPM module as your preferred method.
  • with-script-tag: The result of following the JavaScript quickstart if you chose <script> as your preferred method.

Deploy

Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.

Deploy with Vercel

Running the template

git clone https://github.com/clerk/clerk-javascript-quickstart

To run the example locally, you need to:

  1. Sign up for a Clerk account at https://clerk.com.
  1. Go to the Clerk dashboard and create an application.

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

  3. npm install the required dependencies.

  4. npm run dev to launch the development server.

Learn more

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

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!