Skip to content

karpolan/react-mui-pro-starter

Repository files navigation

IMPORTANT UPDATE 2024-05-01

Better use Vite + React + MUI starter instead of this one.

Reasons:

  • Create React App is not popular anymore.
  • TypeScript is more predictable than JavaScript for React application development and maintenance.
  • Development and debugging using Vite is 10x faster than with Webpack.

React + Material UI Professional starter

Mix of Create React App and Material UI with set of reusable components and utilities to build professional React Application faster.

How to use

  1. Clone or download the repo from: https://github.com/karpolan/react-mui-pro-starter
  2. Copy env.sample to .env, or at least set env.REACT_APP_LOG_LEVEL = DEBUG | INFO | WARN | ERROR variable
  3. Replace _TITLE_ and _DESCRIPTION_ in all files with own texts
  4. Create Favorite Icon images and put them into /public/img/favicon, the favicon.ico file should be paced into root of /public folder.
  5. Add your own code :)

Available Scripts

In the project directory, you can run:

npm start or npm run dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run lint

Checks the code for errors and missing things

npm run format

Formats the code according to ./prettierrc.js config

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify