Skip to content

six-ponies/mui-react

Repository files navigation

mui-react Build Status npm version

Mobile web UI based on React

Docs

See the [examples][examples] built with mui-react. Detailed documentation is on the way...

Local setup

  • Install the dependencies with npm install
  • Run tests npm test
  • Run tests in watch mode npm run test:watch
  • Run the docs site in development mode with npm run docs. This will show you the examples built with react-mui locally
  • Build src with npm run build

Usage

  • Install the repository with npm install mui-react --save
  • Import css file so you can use mui-react styles import 'mui-react/dist/mui-react.css'
  • Import components with import {Button} from 'mui-react'
  • If you don't want the whole file, you can just import with import Button from 'mui-react/lib/components/Button.js'
  • Have fun using mui-react [examples]: https://lordisback.github.io/mui-react.github.io