glrodasz/cero-components

Component library for Cero a Producción Project

Cero Components

0️⃣ 🚀 Cero a Producción is a project of live coding sessions where we develop a a productivity management app called RETO from the scratch to production.

The idea behind

The objective of these sessions is to provide an authentic developer experience where we delve into the myriad of decisions that a typical programmer makes on a daily basis, using JavaScript and other relevant tools. Participants will observe failed tests, code refactoring, and the utilization of search engines such as Google and StackOverflow. Additionally, participants can expect to enjoy the process and witness the challenges of naming variables and functions.

Check the video sessions of this product here and follow me on

Table of Contents

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

Getting Started

You must have react and react-dom installed those are peer dependencies of this project.

1. Installation

Using NPM

npm install @glrodasz/components

Using Yarn

yarn add @glrodasz/components

2. Using the library

• Import component

import { Icon, ButtonIcon } from '@glrodasz/components'

• 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 https://github.com/glrodasz/cero-components.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.