@setapp/ui-kit NPM

Setapp Ui-kit

Project directories structure

styles - UI kit stylesheet sources

images - UI kit images

src/components - React UI kit components

src/tests - Unit tests for UI kit components

src/stories - Storybook stories

public - UI Kit demo pages and static Storybook. Published to GitHub Pages

scripts - script used for development purposes

.storybook - Storybook config

Contributing guide

Create feature branch and perform changes.
Push changes to the origin and create pull-request.
After pull-request merging update local master.
Bump version and add a tag (for example using npm version).
Push changes to the origin.
Publish new version to NPM.

TIP: you can use np to perform these steps automatically

Versioning rules

This package uses Semver for versioning

Testing in related projects

There is a way to test new version of UI-kit without publishing it to NPM: 1. Execute npm link inside UI-kit project root. 2. Execute npm link @macpaw/setapp-ui-kit inside related project's root. 3. Rebuild related project if needed.

Scripts

npm run build:ui-kit - build theme and open demo in browser
npm run watch:ui-kit - same as npm run theme but with watching for .scss files changes
npm run build:storybook - build storybook
npm run watch:storybook - start storybook
npm lint - lint react components
npm test - run tests for react components
npm run coverage - run tests for react components with coverage checks and generate coverage reports
npm run build - build ui-kit components to /dist using custom script from /scripts/build.js