@bcgov/citz-imb-sso-react NPM

BCGov SSO Integration for React

`Introduction`

This npm package offers an integration solution for connecting React applications requiring authentication to the B.C. government's Single Sign-On (CSS) service. It abstracts the complexity of handling SSO protocols manually. By using this package, developers can quickly implement authentication and authorization in their React applications to meet B.C. government security standards.

Built for a NodeJS:20 React app.
For CSS Gold Standard with usecase set as Browser Login and Service Account.
Works with Vanilla JavaScript or TypeScript 5.
For use with an Express API using @bcgov/citz-imb-sso-express

`Get Started Here!`

Documentation - Installation, setup and usage guides.

IMPORTANT
These packages complement, rather than replicate, Common Hosted Single Sign-On (CSS) or it's example apps.
They allow our own applications to integrate with the Common Hosted Single Sign-On (CSS) Service, providing us access to it's user management capabilities.
They are developed and maintained by the CITZ IMB Common Code team, separate from the Common Hosted Single Sign-On (CSS) team.
See why we made these packages at Purpose and Benefits of This Package.

`For Developers working on this package:`

We emphasize the inclusion of documentation on our code to enhance onboarding efficiency. Understanding the project's architecture and operational dynamics create efficient team members.

We encourage collaboration by making our project's infrastructure transparent and accessible. Enabling developers to easily navigate and contribute to different parts of the codebase without barriers. Enriching our documentation contributes to a self-documenting codebase. The project's structure and commands are defined and updated within the repository itself. Ultimately, making the project more maintainable and scalable over time.

Use the links below to help you understand the codebase better.

Return to Top