Watcher UI is a UI library designed for decentralised React webapps written in TypeScript.
It is styled and themed with Styled Components and Styled System. Storybook is used heavily to keep the components modular and document use-cases. It also uses Rimble Icons with some custom additions.
# Go to your favourite directory and clone
git clone git@github.com:DJRHails/watcher-ui.git && cd watcher-ui
# Install all depedencies
yarn install
# 🎉 that’s it, you've installed repo locally. One last step!
Runs Storybook in the development mode.
Open http://localhost:9009 to view it in the browser.
The stories will reload if you make edits.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Plob is used to speed up generating new components.
# Generate a reusable component
yarn generate component <name>
yarn generate component DogCard
# Generate a custom hook (WIP)
yarn generate hook <name>
yarn generate hook useAsync