@canoadigital/astrocentro-components
v1.0.0
Published
This project is created using Direflow and Storybook
Downloads
1
Maintainers
Readme
Astrocentro components
Astrocentro's default library of web/react components.
Getting started
- Clone the repository
git clone [email protected]:canoadigital/astrocentro-components.git
. - Run
cd astrocentro-components
. - Run
npm install
.
Starting Direflow's development environment
- Run
npm start
.
Direflow will start running on localhost:3000 and your browser will open a new window.
Starting Storybook's development environment
- Run
npm run storybook
.
Storybook will start running on localhost:6006 and your browser will open a new window.
Creating a new component
See the docs at Confluence.
Build Direflow's web components
- Run
npm run build
.
This will create a/build
folder containing adireflowBundle.js
file.
Build Direflow's react components
- Run
npm run build-lib
.
This will create a/lib
folder containing the react component library.
Publish Direflow components in NPM
- Run
npm publish
.
Preview Storybook's documentation
- Run
npm run storybook-docs
.
Storybook will run on localhost:52394 and your browser will open a new window with the docs preview.
Build Storybook's documentation
- Run
npm run build-storybook-docs
.
This will create a/storybook-static
folder containing storybook's documentation.
Prerequisites
Node.JS version: ^14.0.0.
Built With
Direflow - Web/react component builder.
Storybook - Component's documentation.
Authors
- Matheus Henrique - Initial work.