cv-lib-app-components v4.0.0

Table of Content

• Before use
  • Requeriment
• Create new Components
  • Clone and install the repository
  • Create a new folder and component files like this
  • Add component to StyleGuidist config file
  • Add component to RollUp config
• Commands
  • Run Styleguidist
  • Check Eslint
  • Generate dist folder
  • Prepare S3 files

Before use

Requeriment

Create new Components

Clone and install the repository

git clone git@bitbucket.org:grupoblidoo/cv-lib-app-components.git
cd cv-lib-app-components && npm ci

Create a new folder and component files like this

Component.js : Component code

Component.md : Component documentation and examples

styles.js : Component styles (styled-components and material ones) OPTIONAL

Add component to StyleGuidist config file

file : styleguide.config.js

name : Section title

components : Section components

content : Extra section Information

Add component to RollUp config

Rollup is the library responsible for generating the dist folder

file : rollup.config.js

key : Component name (It will be used on dist)

value : The path of component main file

Commands

Run Styleguidist

npm start

Check Eslint

npm run eslint

Generate dist folder

npm run build

Prepare S3 files

npm run build:prod