@botco/library

library

Botco UI Components

Usage

run yarn storybook in a terminal run yarn start in another

Test local changes in any project

To be able to test our changes in any project, the first thing we must do is build the @botco/library library locally running in the root folder yarn build, after this have to run the following command yarn link (reference how this command works).

In the project that has @botco/library installed we must run yarn link "@botco/library" and then yarn install, to be able to link locally both repositories.

Going back to the @botco/library library in the root folder and run the command yarn start this will allow us to make changes in our code and that this is reflected immediately in the project which we have installed @botco/library.

Summary

On @botco/library

    yarn build
    yarn link
    yarn start

On @botco/{my_aweasome_project}

    yarn link "@botco/library"
    yarn install

⚠️ IMPORTANT!!!!! 👀

Once we are done with our changes, we must go back to the build folder and run yarn unlink and in the repository where @botco/library was implemented, we must run yarn install --force in order to restore this dependency and install it using npm again.

    yarn unlink
    yarn install --force

NOTE:

Making changes to the library components will automatically update Storybook, but to see those changes reflecting in the authoring-tool you need to restart the server with yarn start from any project using the library

DEPLOY STORYBOOKS TO S3

To deploy storybooks to S3 instance run the next command npm run deploy-storybook.

prerequirements: you should have aws installed and the aws botco account configured in it before run the command specified above.

TODOS

Clean up prettier rules to what we want Define TSLint rules to what we want Create real components