Skip to content

A modular library components, mande with ReactJS for a project opensource Design System

License

Notifications You must be signed in to change notification settings

deppbrazil/black-pearl

Repository files navigation

Black Pearl 🏴‍☠️ Donate

Translate

Banner

Codacy Badge Repo size License

Get Started

Setup, you need:

  • Nodejs vs +12.0
  • Yarn vs 1.22.*
  • Lerna vs +3.0

Run in main directory

foo@bar:~$ yarn
foo@bar:~$ yarn lerna bootstrap

Run in /cli directory

foo@bar:~$ yarn
foo@bar:~$ yarn link
foo@bar:~$ blackpearl -h

Run in main directory to view Documentation with DOCZ

foo@bar:~$ yarn start:docs

Run for documentation deploy in AWS S3

foo@bar:~$ blackpearl deploy docs

Create components

Run for create new component

foo@bar:~$ blackpearl generate component NameComponent

Always run when creating a new component

foo@bar:~$ yarn
or,
foo@bar:~$ yarn lerna bootstrap

Run a build

foo@bar:~$ yarn build

Run a unit tests for componentes

foo@bar:~$ yarn test

Copyright © Mir Carvalho 2021

About

A modular library components, mande with ReactJS for a project opensource Design System

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published