React Ready

January 6, 2020 ยท View on GitHub

Build Status

react-ready

React Ready

A boilerplate that consists of the essential elements that are required to start building a Single Page Application using React, React Router, Redux and Material UI.

The boilerplate consists of:

  • Typical container structure
  • Redux and Redux-thunk integration
  • List and forms(In-progress)
  • Admin Panel
  • React-Router
  • Material UI
  • Axios http client
  • Multi-layouts support
  • Public and private routes
  • ESLint and prettier configuration
  • CI integration

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development.

Prerequisites

The following software is required to be installed on your system:

  • Node 10.x
  • Npm 6.x

Type the following commands in the terminal to verify your node and npm versions

node -v
npm -v

Install

Follow the following steps to get development environment running.

  • Clone 'react-ready' repository from GitHub

    git clone https://github.com/saqibabbas/react-ready.git

    OR USING SSH

    git clone git@github.com:saqibabbas/react-ready.git

  • Install node modules

    cd react-ready
npm install

Build

Build Application

  npm run build

Run ESlint

Lint Project Using ESLint

npm run lint

Lint Project Using ESLint, and autofix

npm run lint:fix

Run Prettier

Prettify Project

npm run prettify

Run

Run Start

npm run start

Authors