@omidanalyzer/decore
v0.2.1
Published
omid.ir ui kit
Downloads
3
Readme
Omid Analyzer UI Framework
Omid.ir UI KIT package.
Features
- Typescript
- Components generators
- Development Environment: Storybook
- Styles: Styled Components with theming configuration
- Lint: typescript eslint
- Tests: Jest
Quick start
Make sure that you have Node v8 or above installed.
- Clone this repo
- Move to the appropriate directory:
cd decore
. - Run
npm ci
in order to install dependencies. - At this point you can run
npm start
to see the example Storybook at http://localhost:4008.
Creating new components
To add a new component, just run npm run generate
. This command will generate all the component (Stateless or not) files for you.
Testing
To test your components run npm test
.
By default we run tests and lint before any push.
Deploying storybook
To deploy storybook run npm run deploy-storybook
.