Little Miss Robot - Sass system (DEV)

This repository contains as system that lets you manage a couple of fundamental design elements: color, spacing, typography and breakpoints. This package is depended on different partial packages providing their respective functionality. This README is meant for the dev team and should not be published!

Setup

1. Install the dependencies:

npm install

2. Start the development environment:

npm run start

Scripts

| Command | Description | | --------------- | ----------------------------------------------------------------------------------------------------------- | | npm run start | Start the development environment where Sass starts compiling the tests/index.scss file to the dist folder. | | npm run lint | Use stylelint to lint sass and css to check if everything is formatted correctly. |

Structure

| Folder | Description | | ------------------------ | --------------------------------------------------------------------------- | | lib | Contains all the code that should be published to NPM as a package. | | tests.html, tests.scss | Testing files during development of the package, should never be published. |

Publish to npm

1. Change the version in the package.json to the wanted version number. Examples: 2.0.5 -> 2.0.6: for a small patch. 2.0.5 -> 3.0.0: for a breaking change.

2. Push your changes to master.

3. Manually run the Publish to NPM step in the pipelines when the automated steps have succesfully finished.

Contact

• [email protected]