Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.5 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.5 KB
Raw

Material-UI Template

This is a template site that you can use as a starting point for your Material-UI (MUI) project. I created it by starting with the awesome MUI docs site so it has the same master layout as that, but there are significant differences:

  • Stands alone. The MUI docs site is a subfolder of the main MUI project and components in the docs site references its parent. While it's not hard to tease this apart for someone who is familiar with webpack, npm, React, and MUI, it's not fun to have to do that before diving into your first MUI project... especially for newbies.

  • DRY and n-levels of left nav menu. To add/modify the left nav of the original MUI docs, you had to modify no less than three different source files. This template will automatically adjust the left-nav based upon app-routes.js including n-levels deep.

  • Custom theme in the project. MUI is designed to be themable and comes with two nice themes, but it's not immediately obvious how to activate a custom theme in context for all components. The Themes page now has three themes and it defaults to the custom one, so if you remove the Themes page, it will start up with your theme rather than one of the prebuilt ones. Just modify customBaseTheme.js. I also modified many components and pages to use the theme. There were many places where inline settings didn't honor theme colors and spacing.

  • Highcharts. There is an example chart page that uses Highcharts and react-highcharts.

  • Advanced Table. Included is a component that renders a table where you can click on the columns to accomplish sorting.

Requirements

Installation

After cloning the repository, install dependencies:

cd <project folder>/material-ui-template
npm install

Running

Once dependencies are installed, start the application with:

Browser

npm run browser:development

Open http://localhost:3000 to view the template site.

iOS

npm run native:development

Open ios/iosApp.xcodeproj in Xcode, build and run the project.

Android

npm run native:development
npm run android:setup-port
react-native run-android