Getting Started

This project, will help to have the same icons, components and colors between projects.

Install

1. yarn install
2. yarn storybook

open browser in http://localhost:6006/

How it works

• SVG Images

1. Need to create or add into a folder the svg image.
2. In the carpet "images" need to create the name of the component with the follow pattern: "{nameImage}{number_Pixel}Px.svg"
3. Create a normal component of react
4. Copy the content of the svg image and return it into the component.
5. In the index of folder "images" export the default component to be found.
6. In the index of src folder export it too.

• New component

1. Need to create a folder with the name of component
2. Create 3 files, {name}.scss, {name}.jsx and {name}.stories.jsx (stories is the file detected by storybook to display it)
3. Export it into the index in src folder.

• SCSS files IMPORTANT: Each time we create a new scss file, we need to add it into the "style-guide.scss" file.

1. Colors.scss is the main file where we add the hex color. Should be HEX to avoid have repeated colors.
2. To use any color, in the scss file of component just import ""@import "../colors/colors.scss";"

Publish new version

First, be sure you're login into npm and yarn.

Run: npm login Run: yarn login

In terminal:

1. yarn buildPublish -> this generate the build of package
2. yarn publish -> this publish the version into yarn
3. npm publish -> this publish the version into npm