Overview

The Component Library Starter is a small starter kit for building a component library using styled-components. It is designed to help users create their own components and easily publish them to npm. The library is set up to use styled-components, polished, and styled-components-modifiers.

Features

• Integration with styled-components, polished, and styled-components-modifiers
• File structure based on Blocks, Elements, and Modifiers concept
• Linting for JavaScript and SCSS
• Initial test suite using Jest

Installation

To install the component library starter and its dependencies with Yarn, run the following command:

yarn install

If you prefer to use npm, you can use the following command instead:

npm install

Summary

The Component Library Starter provides a convenient starting point for building a component library using styled-components. It offers integration with popular libraries like polished and styled-components-modifiers, a file structure based on the Blocks, Elements, and Modifiers concept, and support for linting and testing. By following the provided guidelines, users can easily create their own components and publish them to npm.