tagliatelle-components

Usage

To use this package in an app use the following command:

npm i tagliatelle-components -D

This package has tagliatelle-icons and tagliatelle-tokens as a dependency.

Development

To create a new component please run the following command to generate the required files.

  npm run generate-component

This command will require you to respond to two questions.

? Please select which category the new component belongs to? (Use arrow keys)
❯ atoms 
  molecules 
  organisms 

? What is the component name? (please use camelCase)

You'll find your new component folder in the following directory packages/components/src/{category}

The new component folder will come with a *.stories.js file ready so you can see the changes you make on Storybook.

Run npm run start to launch Storybook on the browser at http://localhost:6006/.

Outputed required files

A folder with four new files will be created;

1. component.js
2. component.style.js (We use styled-components)
3. component.test.js (Take a snapshot of your built component!)
4. index.js

Updating the package

To update the package with the changes you made, please commit your changes and run lerna version.

Run npm run clean && npm run bootstrap to update the package.json and commit your changes once more and then raise a PR.

After the review has been approved, build the package with npm run build and then publish it to npm with lerna publish.