README.md

react-app-boilerplate

A boilerplate for faster creating React applications

This boilerplate is quite workable template. It allows to:

• login user (used fake user data via faker)
• logout
• render header, main content and footer

There is no any UI library such as Material UI, Ant Design or anything else. This is intentional: feel free to choose any your like.

Used packages

Routing

• react-router-dom
• connected-react-router

State management and side-effects

• redux
• react-redux
• redux-saga
• reselect
• seamless-immutable

Styling

• clsx
• styled-components

Handling forms

• formik
• yup

Custom Hooks

• react-use

Utils

• axios
• faker
• lodash
• mitt
• uuid

Not used, but preferable

• date-fns

Cloning and updating

To clone

$ git clone https://github.com/daminort/react-app-boilerplate.git

To check updates for used packages

$ cd <project-root>
$ npm run check-updates # will run: npx npm-check-updates

To update used packages

$ cd <project-root>
$ npm run update # will run: npx npm-check-updates -u

Note that npm run update updates package.json only, so you will need to install new versions manually after that:

$ npm install

Available scripts (apart from standard ones and updating scripts)

$ npm run lint # start linter for `src` folder
$ npm run lint-fix # start linter with fixes for `src` folder

Using with Docker and Docker-compose

You can run project in Docker container in development mode:

$ docker-compose up --build
$ # or
$ docker-compose up

Project structure