create-material-ui-app's Introduction

Create Material-UI App

CRA & Material-UI based boilerplate with:

@material-ui/core
react-scripts
@storybook/react
storybook-addon-material-ui

How to use

git clone https://github.com/react-theming/create-material-ui-app.git
cd create-material-ui-app
yarn # select @storybook/react version when prompted
yarn storybook

open http://localhost:9009 in your browser

it's your Storybook with Material-UI components

Start writing new stories from src/stories/index.js file. Create your app as an usual CRA app.

Notes about this boilerplate

Create Material-UI App is built on top of Create React App, which means all features that create-react-app supports are available.

We recommend sticking with this boilerplate for new projects since we trying to keep here the newest stable configuration.

CONTRIBUTING

Any feature requests, issues, PRs to this project are very welcome!

Credits

telegram:@usulpro

anonymous survey to collect feedback about this project

create-material-ui-app's People

Contributors

Stargazers

Watchers

create-material-ui-app's Issues

cra-template possibility

This project looks very good and I was wondering if you've considered/explored the possibility of turn it into a cra-template.

Theme switch doesn't work and test's fail

Thanks for the example!
Will trying it out (npm -version 6.4.1)

git clone https://github.com/react-theming/create-material-ui-app.git
cd create-material-ui-app
npm install
npm run storybook

I ran into two issues:

The rendered component don't change if I switch between light and dark theme.
The test fails

 FAIL  src/Storyshots.test.js
  ● Test suite failed to run

    Cannot find module '@storybook/addon-storyshots' from 'Storyshots.test.js'

    > 1 | const initStoryshots = require('@storybook/addon-storyshots').default
        |                        ^
      2 | initStoryshots()
      3 | 

      at Resolver.resolveModule (node_modules/jest-runtime/node_modules/jest-resolve/build/index.js:230:17)
      at Object.require (src/Storyshots.test.js:1:24)

 PASS  src/App.test.js

Test Suites: 1 failed, 1 passed, 2 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        1.167s
Ran all test suites.

Watch Usage: Press w to show more.

Recommend Projects