Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glrodasz/cero-components
Component library for Cero a Producción Project
https://github.com/glrodasz/cero-components
atomic-design components design-system design-tokens react storybook
Last synced: 3 months ago
JSON representation
Component library for Cero a Producción Project
- Host: GitHub
- URL: https://github.com/glrodasz/cero-components
- Owner: glrodasz
- Created: 2020-09-23T19:40:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-08T06:40:07.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T14:06:54.574Z (4 months ago)
- Topics: atomic-design, components, design-system, design-tokens, react, storybook
- Language: JavaScript
- Homepage: https://cero-components.vercel.app
- Size: 1.26 MB
- Stars: 53
- Watchers: 6
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Cero Components
[](https://github.com/glrodasz/cero-components/actions/workflows/release.yml) [](https://app.codecov.io/gh/glrodasz/cero-components) [](https://www.npmjs.com/package/@glrodasz/components) [](https://github.com/semantic-release/semantic-release)
[](https://github.com/storybookjs/storybook)
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](https://glrz.me/youtube-cero) and follow me on [](https://glrz.me/stream)
## Table of Contents
- [Getting Started](#Getting-Started)
- [Storybook](#Storybook)
- [Running the project locally](#Running-the-project-locally)
- [Running the tests](#Running-the-tests)
- [Methodologies](#Methodologies)
- [Atomic Design](#Atomic-Design)
- [Molecules definition](#Molecules-definition)
## Getting Started
> You must have `react and react-dom installed` those are peer dependencies of this project.
#### 1. Installation
_Using NPM_
```bash
npm install @glrodasz/components
```
_Using Yarn_
```bash
yarn add @glrodasz/components
```
#### 2. Using the library
- Import component
```jsx
import { Icon, ButtonIcon } from '@glrodasz/components'
```
- Use component
```js
Cowards Agreed
```
## Storybook
Check the rest of the available components in our [Storybook](https://cero-components.vercel.app)
## 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 test`or `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](https://shop.bradfrost.com/products/atomic-design-ebook). 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.