A boilerplate to build a React component library.

Motivation

To finish with reworking when working with micro front ends, it is necessary to share components between different projects. So I created this project to don`t repeat confs on new libs and facilitate the work of new developers.

How to create a project using this boilerplate?

1. Clone this repository.
2. Run the script-name-replace to change project name.
3. Modify and create themes on theme package.
4. Modify and create components on components package.

How is the repo structured?

This repo is managed as a monorepo that is composed of two packages: themes and components.

Commands

You need to run this command before the storybook, lint or test commands, becouse it is necessary to create links.

How to build project?

  yarn build

How to build storybook?

  yarn storybook:build

How to show storybook?

  yarn storybook:start

How to run lint?

  yarn lint

How to run tests?

  yarn test

Libs that project depends

This libs are Peer Dependencies of this project.

• Polished
• React
• React-Dom
• Styled-Components
• Styled-Components-Modifiers
• Styled-Theme
• Styled-Tools

License

Licensed under the MIT License, Copyright © 2019-present Felippe Maurício.