|
| 1 | +<p align="center"> |
| 2 | + <a href="http://rne-storybook.surge.sh/"> |
| 3 | + <img alt="react-native-elements-storybook" src="https://user-images.githubusercontent.com/17120764/56100603-19199580-5f45-11e9-96a6-dd80f61b4932.png" width="450"> |
| 4 | + </a> |
| 5 | +</p> |
| 6 | + |
| 7 | +<p align="center"> |
| 8 | + A <a href="https://storybook.js.org/">Storybook</a> for <a href="https://react-native-training.github.io/react-native-elements/">React Native Elements</a> UI Library |
| 9 | +</p> |
| 10 | + |
| 11 | +<img src='https://user-images.githubusercontent.com/17120764/55798647-af8b2880-5af9-11e9-81d9-98d21fbe5250.png' /> |
| 12 | + |
| 13 | +## Get Started |
| 14 | + |
| 15 | +### Development |
| 16 | + |
| 17 | +1. Install package dependencies |
| 18 | + |
| 19 | +``` |
| 20 | +➜ react-native-elements-storybook git:(master) ✗ yarn |
| 21 | +``` |
| 22 | + |
| 23 | +2. Start Storybook |
| 24 | + |
| 25 | +``` |
| 26 | +➜ react-native-elements-storybook git:(master) ✗ yarn storybook |
| 27 | +``` |
| 28 | + |
| 29 | +It will start [webpack-dev-server](https://github.com/webpack/webpack-dev-server) at port 6006 and opens the browser automagically. |
| 30 | + |
| 31 | +``` |
| 32 | +╭────────────────────────────────────────────────────╮ |
| 33 | +│ │ |
| 34 | +│ Storybook 5.0.6 started │ |
| 35 | +│ 20 s for manager and 22 s for preview │ |
| 36 | +│ │ |
| 37 | +│ Local: http://localhost:6006/ │ |
| 38 | +│ │ |
| 39 | +╰────────────────────────────────────────────────────╯ |
| 40 | +``` |
| 41 | + |
| 42 | +### Deployment |
| 43 | + |
| 44 | +1. Export storybook as a static web app and place it inside the `.out` directory |
| 45 | + |
| 46 | +``` |
| 47 | +✗ yarn build-storybook |
| 48 | +``` |
| 49 | + |
| 50 | +2. Now you can deploy the content in the `.out` directory wherever you want. |
| 51 | + |
| 52 | +To test it locally, using [serve](https://www.npmjs.com/package/serve) for example: |
| 53 | + |
| 54 | +``` |
| 55 | +✗ npx serve .out |
| 56 | +``` |
| 57 | + |
| 58 | +## Components included: |
| 59 | + |
| 60 | +- [x] [Avatar](http://rne-storybook.surge.sh/?path=/story/avatar-icons--default-size) |
| 61 | +- [ ] Badge |
| 62 | +- [x] [Button](http://rne-storybook.surge.sh/?path=/story/button-button--with-title) |
| 63 | +- [ ] ButtonGroup |
| 64 | +- [ ] Card |
| 65 | +- [ ] CheckBox |
| 66 | +- [ ] Divider |
| 67 | +- [ ] Header |
| 68 | +- [ ] Icon |
| 69 | +- [ ] Image |
| 70 | +- [ ] Input |
| 71 | +- [ ] ListItem |
| 72 | +- [ ] Overlay |
| 73 | +- [ ] Pricing |
| 74 | +- [ ] Rating |
| 75 | +- [ ] SearchBar |
| 76 | +- [ ] Slider |
| 77 | +- [ ] SocialIcon |
| 78 | +- [ ] Text |
| 79 | +- [ ] Tile |
| 80 | +- [ ] Tooltip |
| 81 | + |
| 82 | +## Contributing |
| 83 | + |
| 84 | +Interested in contributing to this repo? Submit a PR for a new feature/bug fix. |
| 85 | + |
| 86 | +### First Contributors |
| 87 | + |
| 88 | +We encourage everyone to contribute & submit PR's especially first-time |
| 89 | +contributors. Look for the label `Good First Issue` on the issues. Click |
| 90 | +[here](https://github.com/haruelrovix/react-native-elements-storybook/labels/Good%20First%20Issue) |
| 91 | +to see them. |
| 92 | + |
| 93 | +If there is something you's like to see or request a new feature, please submit |
| 94 | +an |
| 95 | +[issue](https://github.com/haruelrovix/react-native-elements-storybook/issues/new) |
| 96 | +or a |
| 97 | +[pull request](https://github.com/haruelrovix/react-native-elements-storybook/pulls). |
0 commit comments