javascript icon indicating copy to clipboard operation
javascript copied to clipboard

Official Javascript repository for Clerk authentication


Official Clerk JavaScript SDKs

This repository contains all the Clerk JavaScript SDKs under the @clerk/ namespace. Visit https://clerk.dev to signup for an account.

chat on Discord documentation twitter


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/.


Documentation and Usage

For how to get started with Clerk, you can refer to the official documentation page.

For JavaScript environments/platforms that Clerk supports, there should be a specific package corresponding to the respective technology.

npm install @clerk/clerk-sdk-node
# or
yarn add @clerk/clerk-sdk-node

Packages

For package specific details on installation, architecture and usage usage, you can refer to the package's README file.

  • @clerk/backend-core: Functionalities regarded as "core" for Clerk to operate with. Authentication resolution, API Resources etc.
  • @clerk/edge: Top level SDK for edge environments containing all required helpers and middleware.
  • @clerk/clerk-sdk-node: SDK for native Node.js environment and frameworks.
  • @clerk/nextjs: Clerk package for Next.js.
  • @clerk/clerk-js: Core JavaScript implementation used by Clerk in the browser.
  • @clerk/clerk-react Clerk package for React applications.
  • @clerk/clerk-expo Clerk package for the Expo universal app framework.
  • @clerk/types Main TypeScript typings for Clerk libraries.
  • ...

Additionally there are packages which act as shared utilities or building blocks.

Setup

  • Clone the repository.
  • npm install.
  • npm run build.

* See the docs folder for additional repository documentation.