Package Exports

@dotintent/intentbase-ui-auth

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dotintent/intentbase-ui-auth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Intentbase UI Auth

About
Getting started
Conventional Commits
Available scripts
Useful docs

About

UI React components for Log in, Register and Forgot password, to use with auth providers like Cognito

Getting started

Prerequisites

Node.js >= 12
Yarn >=1.22

Installation

yarn install

Prepare and fill secrets

Copy and paste .env.example into .env and fill all secrets.

Secret	Description	Default
NODE_ENV	Define current enviroment	-

Running the app

yarn storybook

Conventional Commits

Commitlint checks if your commit messages meet the conventional commit format.

Example:

feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the the Angular convention) can be: conventional-commit-types

Available scripts

To run script, in terminal type yarn {script}.

Script	Description	Note
`preinstall`	Checks is yarn was used package manager	It runs automatically before every install
`prebuild`	Runs yarn clean	It runs automatically before every build
`start`	Starts app locally
`clean`	Removes build directory if it exists
`build`	Builds app
`serve`	Serves locally app from build directory	Before serve, run `yarn build`
`test`	Runs test for utils and helpers
`type-check`	Checks TypeScript types
`format:check`	Checks prettier rules
`format`	Fix prettier
`lint`	Fix linter
`lint:check`	Checks linter rules

Publishing

npm publish --access=public

@dotintent/intentbase-ui-auth