Skip to main content

Getting Started

warning

Before you start, make sure you have followed the installation guide to set up your project.

This guide will help you get started with the ui-auth and ui-oauth libraries.

Each library provides a set of components that you can use to build authentication flows in your application.

For Angular components, you can use the ui-auth library and for handle OAuth2 authentication, you can use the ui-oauth library.

ui-auth installation​

Let's started by installing the ui-auth library.

$ yarn add @celerofinancas/ui-auth

ui-oauth installation​

For handle OAuth2 authentication, you need to install the ui-oauth library.

$ yarn add @celerofinancas/ui-oauth

Dependencies​

To install the @celerofinancas/ui-oauth library, you need to have the following dependencies installed:

package.json
{
  "dependencies": {
    "@celerofinancas/class-utils": "3.1.x",
    "@celerofinancas/common-domain": "1.3.x",
    "@celerofinancas/core-ts": "3.4.x",
    "@celerofinancas/design-system": "3.4.x",
    "@celerofinancas/onboarding-tour": "2.0.x",
    "@celerofinancas/service-utils": "2.2.x",
    "@celerofinancas/state-management": "2.3.x",
    "@celerofinancas/ui-animations": "3.0.x",
    "@celerofinancas/ui-auth": "1.3.x",
    "@celerofinancas/ui-common": "4.1.x",
    "@celerofinancas/ui-directives": "4.0.x",
    "@celerofinancas/ui-environments": "1.2.x",
    "@celerofinancas/ui-feature-flag": "3.0.x",
    "@celerofinancas/ui-http-services": "1.4.x",
    "@celerofinancas/ui-interceptors": "3.0.x",
    "@celerofinancas/ui-loaders": "1.0.x",
    "@celerofinancas/ui-modals": "3.1.x",
    "@celerofinancas/ui-oauth": "3.0.x",
    "@celerofinancas/ui-pipes": "4.0.x",
    "@celerofinancas/ui-validators": "3.0.x",
    "@matheo/text-mask": "17.0.0",
    "@ngneat/reactive-forms": "5.0.2",
    "@ngxs/devtools-plugin": "3.8.2",
    "@ngxs/store": "3.8.2",
    "date-fns": "2.30.0",
    "ng-recaptcha": "11.0.0",
    "ngx-mask": "17.1.8",
  }
}