Skip to content

Files

Latest commit

 

History

History
67 lines (51 loc) · 5 KB

index.md

File metadata and controls

67 lines (51 loc) · 5 KB

React Material Starter Kit

CircleCI codecov Greenkeeper badge Open Source Helpers PeerDependencies Dependencies DevDependencies

The PRD really starter kit for ReactJs with hot module replacement (HMR) for rapid development.

  • React (16.x)

  • Webpack (4.x)

  • Hot Module Replacement (HMR) using React Hot Loader (4.x)

  • Babel (7.x)

  • JSS this is Css in Jss, the powerfull tool to develop Css using Js. The tool is using natively by Material UI.

  • LESS for style-sheet development. if you don't want to use Jss.

  • SCSS for style-sheet development. if you don't want to use Jss.

  • Jest - Testing framework for React applications

  • Image Loader to loading and minify the images.

  • Redux Manage the Component states.

  • Redux-Thunk The middle-ware of Redux

  • Redux-toolbelt A set of tools for quicker, easier, less verbose and safer Redux development by welldone-software.

  • request-promise and request for WebApi communication.

  • ESLINT for Javascript and ReactJs coding best practises.

  • Code quality (linting) for JavaScript and LESS/CSS.

  • This project also using babel-runtime and babel-plugin-transform-runtime to speperate the commonns functions to the other modules to reduce the size of the js files. Refer here for details.

Original Source Code

Based on the best practises of the Single-Page-Application development with NodeJS. I added the nice font-end component Material-Dashboard-React and Redux store integration.

Beside of that I also developped some useful compoment as Message box, Notification to make the Started-kit to be a Production ready SPA kit.

Installation

  1. Clone/download repo
  2. npm install
  3. Replace the CodeCov.io token to your one in the package.json file.
  4. Run npm start to run the project.

Details Documentation

  1. Styleshet development
  2. Environments
  3. Components
  4. Development

All commands

Command Description
npm run start Build app continuously (HMR enabled) and serve @ http://localhost:8080
npm run start-prod Build app once (HMR disabled) and serve @ http://localhost:3000
npm run start-analysis Build and start Webpack Bundle Analyser @ http://localhost:8888
npm run build Build app to /dist/
npm run test Run tests
npm run lint Run JavaScript and LESS linter
npm run lint:js Run JavaScript linter
npm run lint:less Run LESS linter
npm rum test-ci Run Jest test and upload code to CodeCov.io

See also