Skip to content

Latest commit

 

History

History
executable file
·
24 lines (24 loc) · 887 Bytes

README.md

File metadata and controls

executable file
·
24 lines (24 loc) · 887 Bytes

Mashu Components


A bunch of React components created using styled-components


Getting Started

To start in development, run yarn run storybook.
Navigate to localhost:9009 if it didn't automatically open.
You shouldn't need to npm install or yarn install because yarn.lock is committed.


File structure

You'll work in ./src.
Inside there ./src/packages contain the actual components we're creating and through ./src/stories we put them on the window.


Contributing

NEVER commit to master directly.
Make a branch and open up a PR, Mashu must approve all PRs.


Up and coming to the repo:

the use of DefaultProps to set requiredProps.
the use of knobs and add-ons to test UI in storybook.
tests for all components. add Angular and Vue components. separate components based on framework used.