Skip to content

Commit

Permalink
New readme for descope js (#771)
Browse files Browse the repository at this point in the history
Signed-off-by: Doron Sharon <[email protected]>
  • Loading branch information
dorsha authored Aug 1, 2024
1 parent 2e83b0b commit ff391ab
Showing 1 changed file with 36 additions and 9 deletions.
45 changes: 36 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,50 @@
# Descope JS

The Descope JS repo is composed of many npm packages that are used in Descope SDKs
You can read more on the [Descope Website](https://descope.com).
![github-header-image (2) (1)](https://github.com/descope/.github/assets/32936811/d904d37e-e3fa-4331-9f10-2880bb708f64)

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

This repository hosts multiple packages, located in the `./packages` directory, organized as follows:
## πŸ–₯️ Client SDKs

- ./widgets
- ./sdks
- ./libs
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.

- **[React](https://github.com/descope/descope-js/tree/main/packages/sdks/react-sdk)**
- **[NextJS](https://github.com/descope/descope-js/tree/main/packages/sdks/nextjs-sdk)**
- **[Angular](https://github.com/descope/descope-js/tree/main/packages/sdks/angular-sdk)**
- **[Vue](https://github.com/descope/descope-js/tree/main/packages/sdks/vue-sdk)**
- **[Web Component (HTML)](https://github.com/descope/descope-js/tree/main/packages/sdks/web-component)**


## :cherry_blossom: Widgets

[Descope Widgets](https://github.com/descope/descope-js/tree/main/packages/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](https://docs.descope.com/customize/widgets) about Descope's widgets.


## :open_file_folder: 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](https://nx.dev/). In order to use the repo locally.

1. Clone this repo
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>`

Few repos exposes examples. Refer to packages README to run them
You can find README and examples in each package.

#### Notes

Expand All @@ -31,3 +54,7 @@ Few repos exposes examples. Refer to packages README to run them
## Contact Us

If you need help you can email [Descope Support](mailto:[email protected])

## License

The Descope JS is licensed for use under the terms and conditions of the [MIT license Agreement](./LICENSE).

0 comments on commit ff391ab

Please sign in to comment.