@setapp/ui-kit v2.4.0
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 browsernpm run watch:ui-kit
- same asnpm run theme
but with watching for .scss files changesnpm run build:storybook
- build storybooknpm run watch:storybook
- start storybooknpm lint
- lint react componentsnpm test
- run tests for react componentsnpm run coverage
- run tests for react components with coverage checks and generate coverage reportsnpm run build
- build ui-kit components to/dist
using custom script from/scripts/build.js
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago