0.1.0 • Published 2 years ago
spiria-uikit v0.1.0
UI Kit Storybook
This project was bootstrapped with TSDX.
Requirements
System Requirements
- Nodejs 16+
- Yarn 1.22.0+
Useful Docs
Storybook
TSDX
Steps to Run Locally
1) Install Node Modules by running: yarn install
2) Open the project directory in two separate Terminal windows
3) In one window run: yarn start
4) In the other window run: yarn storybook
Steps to Run Locally for Development
1) Install Node Modules by running: yarn install
2) Open the project directory in a Terminal window
3) In the Terminal window run: yarn dev
Local Development Commands Description
| Command | Description |
|---|---|
yarn start | TSDX scaffolds your new library inside /src. |
yarn storybook | This builds to /dist and runs the project in watch mode on localhost:6006 so any edits you save inside src causes a rebuild to /dist. |
yarn build | This builds to /dist. |
yarn build-storybook | Compiles and generates static version of Storybook to /storybook-static |
yarn test | Run Jest test suite. |
yarn lint | Run source code linting. |
yarn prepare | This builds to /dist. |
yarn size | Calculates the real cost of your library using size-limit. |
yarn analyze | Visualize size |
yarn typed-scss-modules | Generate TypeScript definitions (.d.ts) files for CSS Modules that are written in SCSS, and continue to watch for changes |
yarn dev | Run application in dev mode |
yarn generate | Runs scaffolding to create default versions of files needed to create a new component |
Rollup
TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.
0.1.0
2 years ago