Table of Contents

• Getting Started
• Storybook
• Running the project locally
• Running the tests
• Methodologies
  • Atomic Design
  • Molecules definition

Getting Started

You must have react, react-dom and classnames installed thiose are peer dependencies of this project.

1. Installation

Using NPM

npm install imbric-theme

Using Yarn

yarn add imbric-theme

2. Using the library

• Import component

import { Icon, ButtonIcon } from '....'

• Use component

<ButtonIcon icon="arrowRight" type="primary">
  Cowards Agreed
</ButtonIcon>

Storybook

Check the rest of the available components in our Storybook

Running the project locally

Follow these steps to start the project in development

1. Clone repository. git clone [email protected]:jorgemuriel/imbric-storybook.git
2. Install dependencies in the project folder running yarn or npm install
3. Run Storybook with yarn dev or npm run dev, this command will build the tokens and open Storybook.

Running the tests

1. Run yarn run testor npm run test
2. To keep the tests running, run yarn run test:watch

Methodologies

Atomic Design

For this project will be using the methodology to create componentes called Atomic Design. The component library will be creating just Atoms and Molecules with the following definitions:

Atoms definition

For this project an atom will be a component that is composed by an unique Atom with or without HTML tags, or just HTML tags.

Molecules definition

For this project a molecule is a component that is composed by at least 2 different atoms.