Skip to content

descope/descope-js

Repository files navigation

Descope JS

github-header-image (2) (1)

Welcome to the Descope JavaScript respostiry. The Descope JS respostiry is composed of npm packages, sdks and widgets.

🖥️ Client SDKs

Descope Client SDKs are used to create and manage authentication flows, management widgets, and session management. They are especially useful when integrating Descope into your client application.

🌸 Widgets

Descope Widgets are embeddable components designed to facilitate the delegation of operations to your application's users. These widgets can be utilized in both B2B and B2C contexts, allowing your users to perform various tenant, user management, and project level operations from within the application itself.
Read More about Descope's widgets.

📂 Folder structure

This repository hosts multiple packages, sdks, widgets, located under the ./packages directory, organized as follows:

.
├── ...
├── packages
│   ├── libs         # sdks helpers and drivers
│   ├── sdks         # Descope Client SDKs
│   └── widgets      # Descope embeddable widgets
└── ...

For more detailed information, please consult the README and the specific instructions provided for each package.

Contribution

This monorepo is built and managed using NX. In order to use the repo locally.

  1. Fork / Clone this repository
  2. Run pnpm i
  3. Use the available scripts in the root level package.json. e.g. pnpm run <test/lint/build>

You can find README and examples in each package.

Notes

  • Pull Request title (which is used as the squash & merge commit messages) must met conventional commits (e.g. "fix: ..." / "chore: ...", "feat: ...")
  • Release new versions is done by merging a commit message containing the word RELEASE (e.g. chore: ... RELEASE)

Contact Us

If you need help you can email Descope Support

License

The Descope JS is licensed for use under the terms and conditions of the MIT license Agreement.