MUISCRR Boilerplate Save

Material-UI Styled Components React Redux boilerplate with offline mode support :clapper:

Project README

MUISCRR-boilerplate

Material-UI Styled Components React Redux boilerplate with offline mode support can be used for creating single-page applications with mentioned technologies stack. Mobile and desktop versions are supported.

Demo

You can find Christmas Demo here!:christmas_tree::santa:

  • desktop version :computer:
  • mobile version :iphone:
  • offline mode :up:

Technologies

  • React A JavaScript library for building user interfaces
  • Material-UI next React components that implement Google's Material Design
  • Redux Predictable state container for JavaScript apps
  • Redux-Saga Easier managing application side effects
  • Immutable.js Immutable data for much simpler application development
  • React-Router Collection of navigational components that compose declaratively with your application
  • Styled-Components Visual primitives for the component age
  • Offline-plugin Provides an offline experience for webpack projects
  • PM2 Advanced, production process manager for Node.js
  • Babel Use next generation JavaScript
  • ESLint The pluggable linting utility for JavaScript and JSX
  • Husky Git hooks made easy
  • Prettier Opinionated code formatter
  • Webpack Bundler
  • Cypress Fast, easy and reliable testing for anything that runs in a browser.

Environment

Please, be sure of using latest version of Node.js 8.*.* and npm 5.*.* for correct work

How to use

  • For running in development
git clone https://github.com/yankouskia/MUISCRR-boilerplate.git
npm install
npm run dev
  • For running in production
git clone https://github.com/yankouskia/MUISCRR-boilerplate.git
npm install
npm start

Development

  • npm run dev - run webpack in development build with watch and server concurrently
  • npm run build:dev - run build in development mode with watch
  • npm run serve:dev - run server in development

Production

  • npm run start - run webpack in production mode and server with pm2
  • npm run build - run build in production mode
  • npm run serve - run server in production with pm2

Tools

  • npm run clean - clean build directory
  • npm run lint - run lint checker
  • npm run prettier - run prettier for beautifying code
  • npm run lintfix - run linter in fix mode for editing errors, which it is able to

Contribution

Feel free to create issues and PRs :smiley:

Open Source Agenda is not affiliated with "MUISCRR Boilerplate" Project. README Source: yankouskia/MUISCRR-boilerplate
Stars
34
Open Issues
0
Last Commit
6 years ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating