0.1.1 • Published 3 years ago

intentbase-ui-auth v0.1.1

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
3 years ago

Intentbase UI Auth

CI

Table of Contents

About

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

Getting started

Prerequisites

Installation

yarn install

Prepare and fill secrets

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

SecretDescriptionDefault
NODE_ENVDefine current enviroment-

Running the app

yarn storybook

Available scripts

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

ScriptDescriptionNote
preinstallChecks is yarn was used package managerIt runs automatically before every install
prebuildRuns yarn cleanIt runs automatically before every build
startStarts app locally
cleanRemoves build directory if it exists
buildBuilds app
serveServes locally app from build directoryBefore serve, run yarn build
testRuns test for utils and helpers
type-checkChecks TypeScript types
format:checkChecks prettier rules
formatFix prettier
lintFix linter
lint:checkChecks linter rules

Useful docs