@davidgranados/components v1.13.0

Cero to Production — Components

Cero to Production is a project where we are building a productivity management application called "RETO" in this series of live coding sessions. The idea behindd this sessions is to show all the complications and real thinking and decision making that common programmer do in daily basis with JavaScript.

The project is live streaming in Twitch in Spanish, every Tuesdays and Thursdays.

Table of Contents

• Getting Started
• Run project in dev
• Run test
• Methodologies
  • Atomic Design
  • Molecules definition
• Components Library Creation Guide
  • Storybook configuration
  • Design Tokens
  • Create template script
  • Atoms & Molecules
  • Lint and styling
  • Creating tests
  • NPM scripts
  • Github Actions
  • Publishing in NPM

Getting Started

These are the necessary steps to start using Cero Components as a dependency for a web project.

You must have react installed for our components to work in your application

1. Installation

  npm install @glrodasz/components

2. Use the components.

• Import component

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

• Use component

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

Run project in dev

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. yarn or npm install.
3. Run Storybook yarn dev or npm run dev, this command run Storybook and build tokens. This comman run 2 task yarn dev:storybook and yarn dev:tokens

Check the package.json file, there you will find the commands necessary for the development

Run test

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.

Components Library Creation Guide

These are the instructions about how this components library project has been created for future reference.

Storybook configuration

• Start the project with npx sb init.
• Choose that is a React project.
• Run yarn storybook.
• Add global styles globals.css.
• Add reset styles https://jgthms.com/minireset.css.
• Add typography from Google Fonts.

Design Tokens

• Create tokens/index.js file.
• Add brand colors and decisions
• Create build-tokens script

Create template script

• Create a template script for copy the template of a component with the following structure templates/components and files:

Component.js
Component.module.css
Component.stories.js
constants.js
index.js

• Include inquirer to choose the options from the terminal
• Copy and parse the rest of template files

Atoms & Molecules

• Create Heading Atom
• Create Paragraph Atom
• Create Button Atom
• Create Picture Atom
• Create Avatar Atom
• Create Icon Atom
• Create Check Atom
• Create Card Atom
• Create Spacer Layout
• Create Layout Components
• Create ButtonIcon Molecule
• Create AddButton Molecule

Lint and styling

• Add a modified version of EditorConfig

1. Install ESLint and create a config file following the instructions here
2. Install Prettier yarn add --dev prettier
3. Install the prettier configuration along ESLint following these instructions
4. Finally configure the precommit hook with lint-staged here
5. Configure stylelint

• Install yarn add --dev stylelint stylelint-config-recommended stylelint-config-idiomatic-order
• Create the .stylelintrc.json file
• Configure the scripts for lint css
• Make sure Prettier runs for CSS files as well Note: Idiomatic CSS order based on https://css-tricks.com/poll-results-how-do-you-order-your-css-properties/

Creating tests

1. Install Jest for React following this instructions.
2. Mock the CSS and CSS Modules files for Storybook here
3. Configure Storyshoots here and move snapshots to separate files.
4. Configure Chromatic in https://www.chromatic.com/
5. TODO: Creating unit tests for scripts, utils and helpers
6. Create a coverage script with jest --coverage.
7. Upload the coverage HTML report to a service per pull request

NPM scripts

• Create an script to watch when the tokens/index.js changes and build it. This script should be part of yarn dev.
• Improve scripts structure with concurrently and npm-run-all

Github Actions

• Create a GitHub action when a pull request is made: .github/workflows/review.yml
• Create a GitHub action when pushing in master: .github/workflows/release.yml

Publishing in NPM

• Create the process of release a new version using semantic-release: You need to create a NPM Token (publish) and enable 2FA only for login. Read more here.
• Add yarn add --dev @semantic-release/git @semantic-release/changelog plugin and follow these intructions. Make sure these plugins instructions are clear. Create a .releaserc.json file.
• Make sure the GH_SEMANTIC_RELEASE_TOKEN is configured like this
• Update the .github/workflows/release.yml to skip ci commits with if: "!contains(github.event.head_commit.message, 'skip ci')".
• It is also good idea only enable rebase for pull request in order to let semantic-release check the commit messages properly.
• Configure commitlint https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional and follow these instructions https://commitlint.js.org/#/guides-local-setup
• Configure commitizen to enable conventional commits messages

Adding a Good README

• Create instructions to run this project in dev
• Create instructions to run the tests of this project
• TODO: Add NPM, Coverage, GitHub actions badges to the README.
• TODO: Create a CONTRIBUTING.md file with instructions.