You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-5Lines changed: 10 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -23,19 +23,24 @@ it's your Storybook with Material-UI components
23
23
Start writing new stories from `src/stories/index.js` file.
24
24
Create your app as an usual CRA app.
25
25
26
-
## About this boilerplate
26
+
## Notes about this boilerplate
27
27
28
-
This project was created by these simple tools and steps:
28
+
Create Material-UI App is built on top of [Create React App](https://github.com/facebook/create-react-app), which means all features that create-react-app supports are available.
29
+
You can reproduce these steps to create everything from scratch or choose some of them to add needed tools to your existing project:
29
30
30
31
-`create-react-app` to create a project base
31
-
-`getstorybook` to add a storybook to CRA project
32
-
-`yarn add --dev storybook-addon-material-ui@next` to add support for material-ui
32
+
-`getstorybook` to add a storybook to your CRA project
33
+
-`yarn add --dev storybook-addon-material-ui@next` to add material-ui addon
- add `import 'storybook-addon-material-ui/register'` to `.storybook/addons.js`
35
36
- add `import { muiTheme } from 'storybook-addon-material-ui';` to `src/stories/index.js`
36
37
- add `.addDecorator(muiTheme())` to `src/stories/index.js`
37
38
38
-
So you can perform these steps manually to add `storybook-addon-material-ui` to your existing project. Or stick with this project since we trying to keep here the newest stable configuration.
39
+
We recommend sticking with this boilerplate for new projects since we trying to keep here the newest stable configuration.
40
+
41
+
## CONTRIBUTING
42
+
43
+
Any feature requests, issues, PRs to this project are very welcome!
0 commit comments