https://github.com/stoplightio/storybook-config
Shared storybook config for UI-Kit based project.
https://github.com/stoplightio/storybook-config
Last synced: about 1 year ago
JSON representation
Shared storybook config for UI-Kit based project.
- Host: GitHub
- URL: https://github.com/stoplightio/storybook-config
- Owner: stoplightio
- License: apache-2.0
- Created: 2018-12-17T16:32:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T13:04:51.000Z (almost 2 years ago)
- Last Synced: 2025-04-05T22:43:22.039Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 2.2 MB
- Stars: 5
- Watchers: 18
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @stoplight/storybook-config
A shared storybook config for [UI-Kit](https://github.com/stoplightio/ui-kit) based projects.
- Explore the components: [Storybook](https://stoplightio.github.io/storybook-config)
- View the changelog: [Releases](https://github.com/stoplightio/storybook-config/releases)
### Features
- **Awesome**: It is.
- .. more features
### Installation
Supported in modern browsers and node.
```bash
# latest stable
yarn add --dev @stoplight/storybook-config
```
### Usage
Please refer to UI-Kit repo for an actual usage.
### Contributing
1. Clone repo.
2. Create / checkout `feature/{name}`, `chore/{name}`, or `fix/{name}` branch.
3. Install deps: `yarn`.
4. Make your changes.
5. Run tests: `yarn test.prod`.
6. Stage relevant files to git.
7. Commit: `yarn commit`. _NOTE: Commits that don't follow the [conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) format will be rejected. `yarn commit` creates this format for you, or you can put it together manually and then do a regular `git commit`._
8. Push: `git push`.
9. Open PR targeting the `next` branch.