n8n/packages/design-system/README.md

46 lines
490 B
Markdown
Raw Normal View History

2021-08-09 02:29:11 -07:00
# n8n-design-system
A component system for [n8n](https://n8n.io) using Storybook to preview.
## Project setup
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm install
```
### Compiles and hot-reloads for development
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm run storybook
```
### Build static pages
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm run build:storybook
```
### Run your unit tests
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm run test:unit
```
### Lints and fixes files
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm run lint
```
### Build css files
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm run build:theme
```
### Monitor theme files and build any changes
2021-08-09 03:22:21 -07:00
2021-08-09 02:29:11 -07:00
```
npm run watch:theme
2021-08-09 03:22:21 -07:00
```