README
Universum Component Library
React based component library
Prerequisites
- Yarn > 1.21.1
- Node > 13.8.0
How to Run Locally
- Install dependencies using
yarn
- Run storybook using
yarn storybook
- Storybook should be running on
http://127.0.0.1:9001
How to Run Tests
TODO
How to Build and Publish Project
- Build the project using
yarn build
- Publish the project using
yarn publish
How to export storybook as a static application
- Run
yarn build-storybook
- The static files will be created in
.out
folder - Test if the static files are working correctly using
npx http-server .out
, server should be running onhttp://127.0.0.1:8080
- If everything is correct, deploy the static files on S3, GitHub, Web Server, etc.