ethanneff/template-material-ui

Boilerplate repo with React, Redux Toolkit, TypeScript, React Router, and Material UI

React Material UI Boilerplate

React + Redux Toolkit + TypeScript + React Router + Material UI + Github Pages

https://ethanneff.github.io/template-material-ui/

light	dark

Install

yarn install

Develop

yarn start

Contribute

yarn lint

yarn prettier

yarn test

Deploy

yarn build

Directory

.
├── .github/                # github action CI
├── .vscode/                # IDE configuration
├── build/                  # compiled prod version
├── public/                 # static assets
├── src/
│   ├── components/         # shared UI
│   ├── features/           # shared features (navigation, network)
│   ├── redux/              # shared data
│   ├── screens/            # pages
│   ├── index.css           # global styles
│   ├── index.tsx           # app entry
│   ├── react-app-env.d.ts  # typescript typings
│   └── setupTests.ts       # testing mocks
├── package.json            # dependencies
├── prettier.config.js      # formatting
├── README.md
└── tsconfig.json           # typescript config
└── yarn.lock

Documentation

UI https://mui.com/getting-started/usage/

Redux https://redux-toolkit.js.org/tutorials/quick-start

Navigation https://reactrouter.com/docs/en/v6/getting-started/overview

TODO

• lint errors
• react router
• fix eslint
• redux toolkit
• axios
• mock data
• suspense
• error boundary
• theme