0.1.24 • Published 3 years ago

@mohamed-karawia/library v0.1.24

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

How To Use

In order to get the Storybook development enviornment going on your machine first clone this repo and cd to the project.

Run on your local machine

To run Storybook on your local machine enter the command: npm run storybook

Opening Storybook after it's started

By default Storybook will try to run on port 6006, if this port is already in use it will use a different port that is listed in your terminal. Go to your browser and enter http://localhost:6006 to view the Storybook project.

Contributing

In order to contribute to the project you have to start by creating a new branch from main. The branch syntax should be like so: entity-description. A few examples:

  1. component-comments-view
  2. widget-music-player
  3. space-video-calling

Design Preview

Design previews are available for most components. You can view the design in Storybook by clicking the Design panel.