Awesome Open Source
Awesome Open Source

REACT COOL STARTER

A simple but feature rich starter boilerplate for creating your own universal app. It built on the top of React, Redux, React Router and Express. Includes all the hot stuff and modern web development tools such as Redux Toolkit, TypeScript, Webpack, Babel, PostCSS, React Refresh, Jest and React Testing Library. See the β€œFeatures” section for other awesome features you can expect.

I will maintain the starter boilerplate and keep all of the technologies on trend. Welcome to join me if you want. Hope you guys love it 🀩

πŸ‘€ Looking for a form library? Give React Cool Form a try!

build status coverage status dependencies status devDependencies status code style: prettier All Contributors PRs welcome Twitter URL

Real Case Study

πŸ’‘ If you have built a production web app based on this starter, please open a PR to add it here.

  • Spinny is a fully inspected highest quality second hand cars with money-back guarantee. simple and transparent buying.
  • BAM Music is a new generation of music platform for audio visual professionals, filmmakers and content producers. Upgrade your soundtrack with great music that emphasizes your story!
  • Rendah Mag is a music magazine which exists to bring exposure to an ever-growing community, focusing on the latest Halftime, Beats & Experimental news & releases. Congrats for the amazing product.
  • DealDrop is the best place to find verified coupon codes, deals, promos and offers for thousands of stores & brands you love. Never pay full price again.
  • BECK Friends is an international delivery service, which is built based on this starter boilerplate. Congrats for successful migrating to React.

Features

Really cool starter boilerplate with the most popular technologies:

Who's the Starter for?

They're several React frameworks today, however this is a DIY oriented start-kit. It shows you how to build a universal web app from scratch and how to test it. If you're new to React or you want a ready-to-go solution, I'd recommend the following alternatives for you:

Requirements

Looking for Docker Image?

You can find Docker support version on this branch.

Getting Started

1. You can start by cloning the repository on your local machine by running:

git clone https://github.com/wellyshen/react-cool-starter.git
cd react-cool-starter

2. Install all of the dependencies:

yarn

3. Start to run it:

yarn build  # Building bundle
yarn start  # Running production server

Now the app should be running at http://localhost:8080

Note: You can change the port that you want from the ./src/config.

Script Commands

I use cross-env to set and use environment variables across platforms. All of the scripts are listed as following:

yarn <script> Description
dev Runs your app on the development server at localhost:3000. HMR will be enabled.
dev:build Bundles server-side files in development mode and put it to the ./public/server.
start Runs your app on the production server only at localhost:8080.
build Bundles both server-side and client-side files.
build:server Bundles server-side files in production mode and put it to the ./public/server.
build:client Bundles client-side files in production mode and put it to the ./public/assets.
analyze:server Visualizes the bundle content of server-side.
analyze:client Visualizes the bundle content of client-side.
lint Lints all .tsx?, .jsx? and .scss files.
lint:code Lints all .tsx? and .jsx? files (With --fix to auto fix eslint errors).
lint:type Runs type checking for .tsx? files.
lint:style Lints all .scss files (With --fix to auto fix stylelint errors).
lint:format Formats all files except the file list of .prettierignore.
test Runs testing.
test:watch Runs an interactive test watcher.
test:cov Runs testing with code coverage reports.
test:update Updates jest snapshot.

App Structure

Here is the structure of the app, which serves as generally accepted guidelines and patterns for building scalable apps.

.
β”œβ”€β”€ public                        # Express server static path and Webpack bundles output
β”‚   β”œβ”€β”€ favicon.ico               # App favicon
β”‚   β”œβ”€β”€ logo192.png               # App logo small
β”‚   β”œβ”€β”€ logo512.png               # App logo large
β”‚   └── manifest.json             # App favicon and logo manifest
β”œβ”€β”€ src                           # App source code
β”‚   β”œβ”€β”€ config                    # App configuration by environments
β”‚   β”‚   β”œβ”€β”€ default.ts            # Default settings
β”‚   β”‚   β”œβ”€β”€ index.ts              # Configuration entry point
β”‚   β”‚   └── prod.ts               # Production settings (overrides the default)
β”‚   β”œβ”€β”€ components                # Reusable components
β”‚   β”œβ”€β”€ pages                     # Page components
β”‚   β”œβ”€β”€ app                       # App root component
β”‚   β”œβ”€β”€ store                     # Redux store creator, actions + reducers (a.k.a slice)
β”‚   β”œβ”€β”€ services                  # API calls
β”‚   β”œβ”€β”€ utils                     # App-wide utils (e.g. mock store creator for testing etc.)
β”‚   β”œβ”€β”€ static                    # Static assets (e.g. images, fonts etc.)
β”‚   β”œβ”€β”€ theme                     # App-wide style and vendor CSS framework
β”‚   β”œβ”€β”€ types                     # App-wide type definitions
β”‚   β”œβ”€β”€ client                    # App bootstrap and rendering (Webpack entry)
β”‚   β”œβ”€β”€ routes                    # Routes configuration for both client-side and server-side
β”‚   └── server                    # Express server (with Webpack dev and hot middlewares)
β”œβ”€β”€ webpack                       # Webpack configurations
β”œβ”€β”€ jest                          # Jest configurations
β”œβ”€β”€ babel.config.js               # Babel configuration
β”œβ”€β”€ tsconfig.json                 # TypeScript configuration
β”œβ”€β”€ postcss.config.js             # PostCSS configuration
β”œβ”€β”€ .eslintrc.js                  # ESLint configuration
β”œβ”€β”€ .stylelintrc.js               # stylelint configuration
└── nodemon.json                  # nodemon configuration

Server-Side Security and Performance

Concerning the security and performance of Express in production, I already setup some middleware for you:

  • helmet - Helps secure Express server with various HTTP headers.
  • hpp - Express middleware to protect against HTTP Parameter Pollution attacks.
  • compression - Gzip compression support for speeding up Express server responses.

Note: It's just a basic protected mechanism for your app, you can see the security best practices for more advanced configuration.

Develop with Redux Toolkit

Redux Toolkit is the official, opinionated, batteries-included toolset for efficient Redux development. It includes several utility functions that simplify the most common Redux use cases. In a word, we can do more work with less code, start from the tutorial to learn more about it.

Let's see how powerful it is by a simple asynchronous data fetching example:

import { createSlice } from "@reduxjs/toolkit";
import axios from "axios";

const initialState = {
  readyStatus: "invalid",
  items: [],
  error: null,
};

const userList = createSlice({
  // A name for action types
  name: "userList",
  initialState,
  // An object of "case reducers", key names will be used to generate actions
  reducers: {
    getRequesting: (state) => {
      // Write an immutable updated state by a mutable way, thanks to the built-in Immer middleware
      state.readyStatus = "request";
    },
    getSuccess: (state, { payload }) => {
      state.readyStatus = "success";
      state.items = payload;
    },
    getFailure: (state, { payload }) => {
      state.readyStatus = "failure";
      state.error = payload;
    },
  },
});

// We can get the "reducer" and "actions" from the slice instance
export default userList.reducer;
const { getRequesting, getSuccess, getFailure } = userList.actions;

export const fetchUserList = () => async (dispatch) => {
  dispatch(getRequesting());

  try {
    const { data } = await axios("/api/users");

    // Dispatch the action once data is ready via the built-in Redux Thunk middleware
    dispatch(getSuccess(data));
  } catch (error) {
    dispatch(getFailure(error.message));
  }
};

Overview

Functional Components and Hooks

React v16.8 introduced a series of Hooks, which let you use state and other React features without writing a class. In the starter boilerplate, you can see how I leverage the benefit of functional components + hook APIs to write a demo with clean code.

Adding Routes

This starter use React Router library to manage our routes. For the purpose of SSR with data pre-fetched, I put the routes in a centralized Route Config. You can setup your routes in the ./src/routes/index.ts. For example:

import PageComponent from "../pages/PageComponent";

export default [
  {
    // Define your route path
    path: "/top-path",
    // If the route matches the location.pathname exactly or not (used for index route usually)
    exact: true,
    // Add your page component here
    component: PageComponent,
    // Add your sub route component here
    routes: [
      {
        path: "/top-path/sub-path",
        component: SubComponent,
      },
    ],
  },
  // Other routes...
];

Data Fetching from Server-side

Strongly recommend to write Redux actions and reducers via the createSlice API of Redux Toolkit (start from the tutorial if you are new). The starter using axios as the data fetcher, it's quite simple and easy to use. If the action is asynchronous then it will return a Promise (or a Promise.all) in the inner function.

Register the action(s) in the ./src/routes/index.ts, which have to be called from server-side:

export default [
  {
    path: "/top-path",
    exact: true,
    component: PageComponent,
    // Async actions in the loadData function will be fetched from server-side
    // You can access the URL parameters, Redux store, HTTP request and response by the event object
    loadData: ({ params, getState, req, res }) => [
      myReduxAction(),
      // More pre-fetched actions...
    ],
  },
];

The action(s) will be dispatched through the ./src/server/ssr.tsx on server-side:

app.get("*", (req, res) => {
  // ...

  // Here's the method for loading data from server-side
  const loadBranchData = () => {
    const branch = matchRoutes(routes, req.path);

    const promises = branch.map(({ route, match }) => {
      if (route.loadData) {
        return Promise.all(
          route
            .loadData({
              params: match.params,
              getState: store.getState,
              req,
              res,
            })
            .map((item) => store.dispatch(item))
        );
      }

      return Promise.resolve(null);
    });

    return Promise.all(promises);
  };

  // ...
});

In client-side, don't forget to invoke the action(s) in componentDidMount or useEffect hook. This ensures that if the component is reached on the client, then the same actions will be invoked. It's up to the action(s) to figure out if fetches for data need to be made or not:

// Use React class component
componentDidMount() {
  // Invoke your redux action(s) for client rendering
  this.props.myReduxAction();
}

// Use functional component
useEffect(() => {
  myReduxAction();
}, [])

For better architecture, we can centralize the data fetching methods in one place like how I did in the Home page.

const SomePage = () => {
  // ...

  // Fetch client-side data here
  useEffect(() => {
    dispatch(fetchUserListIfNeed());
  }, [dispatch]);

  // ...
};

// Fetch server-side data here, the method will be used by the route config
export const loadData = () => [fetchUserListIfNeed()];
export default SomePage;

Code Splitting

One great feature of the web is that you don’t have to make your visitors download the entire app before they can use it. You can think of code splitting as incrementally downloading the app. It divides your code into small pieces called "chunks" to reduce the size of bundle loaded by user. Reducing the size of a chunk makes it load and run faster.

To accomplish this, I integrate loadable-components into this starter. The reason I choose the library is because of its design philosophy of SSR. It works seamless with the starter rather than others. Let’s see how we split our app by page:

I use the following folder/file structure:

 └─ pages
    └─ SomePage
       |- PageComponent.tsx  // The page component
       └─ index.tsx          // Wrap the component into async component

The index.tsx will be:

import loadable from "@loadable/component";

import { Error, Loading } from "../../components";
import { loadData } from "./PageComponent";

// Dynamically import your page component
const AsyncPage = loadable(() => import("./PageComponent"), {
  //  <Loading /> will be displayed when the component is being loaded
  fallback: <Loading />,
});

export default (props) => (
  // Wrap an <ErrorBoundary /> to catch the error of <AsyncPage /> (via "componentDidCatch()" life cycle)
  <ErrorBoundary>
    <AsyncPage {...props} />
  </ErrorBoundary>
);
export { loadData }; // Export SSR data fetching method as well

Then you can setup the route as usual.

Note: I just show a general case page-based splitting, however you can even split your app by component-based depends on your needs. For more advanced configuration, please refer to the document. In additional, loadable-components supports Webpack pre-fetching/pre-loading out of the box. <link rel="preload"> and <link rel="prefetch"> can be added directly server-side to improve performances.

Managing Title, Meta, Styles and Scripts

The ./src/app/index.tsx (app root component) defines the base title and meta in a <Helmet {...config.APP} /> component. Any sub-component can override/add properties (supports meta, link, script, style tags and html attributes). See the react-helmet document for more info.

App Configuration

You can store app settings under the ./src/config. By default the default.ts will be loaded. If the process.env.NODE_ENV matches to production (alias as !__DEV__), the prod.ts will be used instead, and it inherits the properties of default.ts.

You can access the correct configuration with:

import config from "./config";

Styles

The starter supports CSS, SASS and CSS modules is auto enabled for all files the [name].module.* naming convention. I use PostCSS plugin to parse CSS and add autoprefixer to your stylesheet. You can access your stylesheet with two ways.

With CSS modules:

import styles from "./styles.module.scss";

// ...

return (
  <div className={styles.myClass}>
    {/* The className matches one of CSS classes in your .scss file */}
    <Helmet title="My title" />
    {this.renderContent()}
  </div>
);

Without CSS modules:

import "./styles.scss";

// ...

return (
  <div className="myClass">
    {/* Use the CSS class as normal */}
    <Helmet title="My title" />
    {this.renderContent()}
  </div>
);

By the way, if you want to use vendor CSS frameworks or global styles, just import it through the ./src/app/index.tsx file (app root component). For example:

import "../../theme/normalize.css"; // Import the vendor stylesheet first
import styles from "./styles.scss"; // Then your based stylesheet

const App = ({ route }) => (
  // ...
};

Image and Font

It's super easy to render the image and font both on client and server, the usage would be like below.

Using image:

import logo from "../static/logo.svg";

<img src={logo} alt="Logo" role="presentation" />;

Using font-awesome:

// With CSS modules
import styles from "./styles.scss";

// ...

return (
  <div>
    <div>
      <i className={styles.iconUser} /> Welly
    </div>
  </div>
);

// Without CSS modules
import "./font-awesome.css";

// ...

return (
  <div>
    <div>
      <i className="fa fa-icon" /> Welly
    </div>
  </div>
);

For using CSS modules, you have to set the proper font path in your scss/sass file:

$fa-font-path: "../node_modules/font-awesome/fonts";
@import "../node_modules/font-awesome/scss/font-awesome";

.icon-user {
  @extend .fa;
  @extend .fa-user;
}

Boost App Performance

In this starter, you can see I use React.PureComponent and React.memo to demonstrate the basic performance optimizing for React app. The two APIs are used in different ways.

  • React.PureComponent is used for React class components. It can do shallow prop and state comparison for a performance boost:
import { PureComponent } from "react";

class MyComponent extends PureComponent {
  // Only re-renders if props change
}
  • React.memo is used for functional components. It plays the same role as React.PureComponent:
import { memo } from "react";

const MyComponent = memo((props) => {
  // Only re-renders if props change
});
  • In addition, you can also use React hooks like useMemo or useCallback to avoid expensive calculations on every render:
import { useMemo, useCallback } from "react";

// Performance optimizing via useMemo()
const ParentComponent = (props) => (
  <div>
    {/* Only re-renders if "a" change */}
    {useMemo(
      () => (
        <ChildComponent someProp={a} />
      ),
      [a]
    )}
  </div>
);

// Performance optimizing via useCallback()
const ParentComponent = (props) => (
  <div>
    {/* Return a memorized callback that only changes if "a" changed */}
    {/* This is useful to prevent child component from unnecessary renders */}
    <ChildComponent
      callback={useCallback(() => {
        doSomething(a);
      }, [a])}
    />
  </div>
);

For more performance optimizing techniques. Please see the Optimizing Performance topic.

TypeScript

TypeScript is a typed super-set of JavaScript. It's getting more and more popular in the Front-end world. And being widely used by many libraries. If you are new to TypeScript, you can check out its document here.

TypeScript has been integrated with our application to bring the following benefits:

  • Type safety for components, reducers, state and actions.
  • Many IDEs support the hints of TypeScript, which give us a superior developer experience.
  • Easy refactoring of typed code.
  • In general, more types less bugs. Read this article to learn more.

Code and Style Lint

ESLint (with Airbnb configuration), typescript-eslint, stylelint, Prettier and lint-staged are integrated into this starter to maintain a consistent code style and give you a elegant code formatting. You can configure your lint rules through the .eslintrc.js, .stylelintrc.js, and prettier configuration file.

Unit Testing

This starter use Jest as the testing framework. We also use React Testing Library with jest-dom, give you a simple and complete React DOM testing utilities that encourage good testing practices.

Jest support the feature of snapshot testing, which is very powerful for testing React component. Give it a try, you'll be impressed. The unit testing focus on three parts as below:

  • Components
  • Actions
  • Reducers

By the way, Jest built-in code coverage reports, the report files are generated in the ./coverage folder. You can configure the ./jest/config.js to define which files that you want to cover. For example:

module.exports = {
  collectCoverageFrom: [
    "src/pages/**/*.tsx", // Define the files, which want to be covered
    "!src/pages/index.ts", // The files will be ignored by code coverage
  ],
  // Other configurations...
};

You can also use istanbul's ignore hints to specify specific lines of code in a JavaScript file to skip code coverage.

How to Deploy

To deploy you app to cloud service (e.g. AWS, GCP, Azure etc.), you can follow the instructions below.

  1. Build then install production dependencies:
yarn build                  # Building bundle
rm -rf node_modules         # After building remove node modules
yarn install --production   # Then install dependencies only
  1. Pack necessary folders/files to your Node.js server:
  • βœ… public
  • βœ… node_modules
  • βœ… package.json
  1. Run your app:
yarn start

Ideally, the above steps can be integrated into your CI. I recommend you to pack the yarn.lock file for yarn installation by CI.

Troubleshooting

  • If you encounter the markup mismatches error (it's a React universal issue, which usually occurs due to the non-synchronized rendering result between client and server), you can do:

    • Restart the server to solve it.
    • Or for v16.1.0 up, you can use suppressHydrationWarning attribute for intentional client/server text mismatches (#11126).
  • If you are on windows and encounter the following error: Expected linebreaks to be 'LF' but found 'CRLF' linebreak-style. The following rule must be added to .eslintrc.js.

// ...
"rules": {
  "linebreak-style": "off",
  // Other rules...
}

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Welly

πŸ’» πŸ“– 🚧

Microflow

🌍

Jason Bacchetta

πŸ”§

Nikita Balabaev

πŸ’»

James Sherry

πŸš‡ πŸ›

Zack Pelz

🌍

apapacy

πŸ’»

martin2786

πŸ“–

iamacup

πŸ”§

Maxim

πŸ”§

Benny Neugebauer

🌍

A. S. Lapkov

πŸ’»

Alireza Valizade

πŸ’»

Grant Millar

πŸ› πŸ’»

Bart

πŸ›

Morteza Tourani

πŸ’»

Tom Kiernan

🌍

Nathan KREMER

πŸ’»

Amer Lotfi Orimi

πŸ”§ πŸ’»

Muhammad Umar

πŸ’»

Denny Vuong

πŸ“– πŸ’»

Matt Carlotta

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
typescript (11,612)Β 
react (5,459)Β 
security (1,909)Β 
redux (1,172)Β 
webpack (1,157)Β 
boilerplate (639)Β 
performance (611)Β 
es6 (527)Β 
express (497)Β 
jest (285)Β 
react-router (210)Β 
react-hooks (206)Β 
unit-testing (188)Β 
starter (147)Β 
server-side-rendering (147)Β 
universal (111)Β 
css-modules (79)Β 
code-splitting (45)Β