@dotintent/intentbase-ui-auth NPM

About

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

yarn install

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

Important Note: AWS secrets must be filled before starting storybook.

Secret	Description	Default
NODE_ENV	Define current environment	-
AWS_COGNITO_REGION		eu-west-1
AWS_COGNITO_USER_POOL_ID		-
AWS_COGNITO_USER_POOL_CLIENT_ID		-

yarn storybook

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 Angular convention) can be: conventional-commit-types.

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

Script	Description	Note
`prepublish`	Builds components	It runs automatically before every publish
`preinstall`	Checks is yarn was used package manager	It runs automatically before every install
`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