-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:lubusIN/wp-storybook
- Loading branch information
Showing
8 changed files
with
168 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
**Change Log** | ||
-------------- | ||
|
||
All notable changes to "WP Storybook" will be documented here | ||
|
||
***v0.1.0*** | ||
|
||
Released on 2 Jan 2018 | ||
|
||
- Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
**Contribution Guide** | ||
---------------------- | ||
|
||
This page contains guidelines for contributing 'WP Storybook'. Please review these guidelines before submitting any pull requests to this package. | ||
|
||
***Pull Requests*** | ||
|
||
The pull request process differs for new features and bugs. Before sending a pull request for a new feature, you should first create an issue with `[Proposal]` in the title. The proposal should describe the new feature, as well as implementation ideas. The proposal will then be reviewed and either approved or denied. Once a proposal is approved, a pull request may be created implementing the new feature. Pull requests which do not follow this guideline will be closed immediately. | ||
|
||
Pull requests for bugs may be sent without creating any proposal issue. If you believe that you know of a solution for a bug that has been filed on GitHub, please leave a comment detailing your proposed fix. | ||
|
||
***Feature Requests*** | ||
|
||
If you have an idea for a new feature you would like to see added to this package, you may create an issue on GitHub with `[Request]` in the title. The feature request will then be reviewed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 LUBUS | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
<p align="center"><img src="assets/logo.png"></p> | ||
|
||
<p align="center"> | ||
<a href="https://wordpress.org/plugins/theme-support/"><img src="https://img.shields.io/github/license/lubusIN/wp-storybook.svg" alt="Licence"></a> | ||
<a href="https://github.com/lubusin/wp-storybook/blob/master/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs"></a> | ||
</p> | ||
|
||
<center> | ||
<a href="https://lubus.in/"> | ||
<img src="https://user-images.githubusercontent.com/1039236/40877801-3fa8ccf6-66a4-11e8-8f42-19ed4e883ce9.png" /> | ||
</a> | ||
</center> | ||
|
||
## Introduction | ||
|
||
Explore various WordPress react components to speed up your development. | ||
|
||
![Storybook Demo](assets/demo.gif) | ||
|
||
## Feedback / Suggestions | ||
|
||
If you have any suggestions/feature request that you would like to see in the upcoming releases , feel free to let us know in the [issues section](https://github.com/lubusIN/wp-storybook/issues) | ||
|
||
## Usage | ||
|
||
- Visit https://wp-storybook.netlify.com/ | ||
- Explore and test various WordPress components | ||
- Search and view different states/variate of components | ||
- Test on different viewports | ||
- Readme and live preview of component in one place | ||
|
||
## Development | ||
|
||
- Clone repo `git clone [email protected]:lubusIN/wp-storybook.git` | ||
- Install all dependencies `npm install` | ||
- Run & watch storybook `npm run storybook` | ||
- Generate static storybook `npm run build-storybook` | ||
|
||
## Changelog | ||
|
||
Please see the [Changelog](CHANGELOG.md) | ||
## Contributing | ||
|
||
Thank you for considering contributing to the `WP Storybook`. You can read the contribution guide lines [here](CONTRIBUTING.md) | ||
|
||
Check the development tasklist [here](https://github.com/lubusIN/wp-storybook/projects/1) if something interest you or suggest something [here](https://github.com/lubusIN/wp-storybook/issues) | ||
|
||
## Security | ||
|
||
If you discover any security related issues, please email to [[email protected]](mailto:[email protected]) instead of using the issue tracker. | ||
|
||
## Credits | ||
|
||
[Ajit Bohra](http://https://twitter.com/ajitbohra) | ||
|
||
## Other Gutenberg Goodies | ||
<table width="100%"> | ||
<tr> | ||
<td width="33.33%"> | ||
<a href="https://github.com/lubusIN/color-palette-block"> | ||
<img src="https://user-images.githubusercontent.com/1039236/38085557-935d7ce8-336e-11e8-920e-dc2d46610c6a.png" alt="Color Palette"/> | ||
</a> | ||
</td> | ||
<td width="33.33%"> | ||
<a href="https://github.com/lubusIN/block-background"> | ||
<img src="https://user-images.githubusercontent.com/1039236/38365718-068c190e-38fb-11e8-8ada-a4a50cfd95d1.png" alt="Block Background"/> | ||
</a> | ||
</td> | ||
<td width="33.33%"> | ||
<a href="https://github.com/lubusIN/dummynator"> | ||
<img src="https://raw.githubusercontent.com/lubusIN/dummynator/master/.wordpress-org/logo.png" alt="Dummynator"/> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr> | ||
<td width="33.33%"> | ||
<a href="https://github.com/lubusIN/wp-theme-support"> | ||
<img src="https://raw.githubusercontent.com/lubusIN/wp-theme-support/master/.wordpress-org/logo.png" alt="Theme Support"/> | ||
</a> | ||
</td> | ||
<td width="33.33%"> | ||
<strong><i>More coming soon ...</i> | ||
</td> | ||
<td width="33.33%"> | ||
| ||
</td> | ||
</tr> | ||
</table> | ||
|
||
## Support Us | ||
|
||
<a href="https://www.patreon.com/lubus"> | ||
<img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become A Patron"/> | ||
</a> | ||
|
||
[LUBUS](http://lubus.in) is a web design agency based in Mumbai, India. | ||
|
||
You can pledge on [patreon](https://www.patreon.com/lubus) to support the development & maintenance of various [opensource](https://github.com/lubusIN/) stuff we are building. | ||
|
||
## License | ||
|
||
`WP Storybook` is open-sourced software licensed under the [MIT](LICENSE) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.