@theycallmealfred/notadesignsystem NPM

About The Project

Built With

- StencilJs

- Storybook

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

npm
```
npm install npm@14 -g
```

Installation

1. Clone the repo

git clone https://github.com/Alfredwooden/NotADesignSystem.git

2. Install NPM packages

npm install

Usage

* To build the component for production, run:

npm run build

* To build Storybook for production, run:

npm run build-storybook

* To run the unit tests for the components, run:

npm test

* For single component development, run:

npm start

* For running Storybook, run:

npm run storybook

* To build Chromatic, run:

npx chromatic --project-token=<CHROMATIC_SECRET_TOKEN>

Contributing

We are using some rules to help to mantain order in the development process, here are some stuff that you might need to know before contributing:

The use of gitflow at the moment of create branchs depending on what are you going to do, more info at GitFlow Kraken

Also at the moment of the commits you should follow an specific rule to be able to commit:

feat: A new feature
fix: A bug fix
chore: Other changes that don't modify src or test files
docs: Documentation only changes
test: Adding missing tests or correcting existing tests
style: Changes that do not affect the meaning of the code.
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
revert: Reverts a previous commit