Buffet.js Icons

Getting Started

$3

Using yarn

``bash
yarn add @buffetjs/icons


Install the required dependencies


yarn add prop-types react styled-components
`

or npm

`bash
npm install @buffetjs/icons --save


Install the required dependencies


npm install prop-types react styled-components --save
`

$3

In order to add a new icon, you can design your svg using Sketch or another design toolkit.

Then you need to clean your svg:

`
npm install -g svgo

svgo my-svg.svg
`

Finally transform the cleaned svg to a React Component.

$3

- build

Builds the library for production
- build:analyze

Analyse the generated build
- build:watch

Whatch the files with webpack
- build:watch:esm

Whatch the files with babel
- create:index

Create the build/index.js` file
- test

Runs the entire set of test: lint, style and jest
- test:jest

Runs the unit tests
- test:jest:watch

Runs the unit tests in watch mode
- test:lint

Runs the lint tests
- test:lint:quiet

Runs the lint tests without displaying the warnings
- test:style

Runs the stylelint tests
- test:style:quiet

Runs the stylelint tests without displaying the warnings
- lint:fix

Fixes the lint