Bonitour Components

A Bonitour Component to rule them all

Table of Contents

• Getting started
• Developing
• Utils

Getting started

The project may be used in two ways, one with the many projects in the repository, or as a standalone project used on production, this ways will be explained below:

Developing

To start your development process you can just develop locally on the folder, as this package doesn't depend on others to work. The whole process of developing the components is made on Storybook, to maintain a visual consistency between enviroments.

## Run this command to develop within the whole ecosystem of applications

pnpm install

## Or just run a local installation inside the `packages/bonitour-components` folder

pnpm install

## And then use this command to start storybook

pnpm start

Utils

To make your development easier we provided some tools to make a standardized and better code.

Hygen

With the purpouse to create your components you may just run the following command:

  pnpm new:component

This command will generate a fresh new component, with the name you provided, with the right path folder and the SCSS, JS and Story files, enabling a quick development.