❤
npm
Sign UpSign In

express-react-boilerplate

4.2.1 • Public • Published

erb

🔥 🔥 🔥 Express react boilerplate 🔥 🔥 🔥

dependency status devDependency status ESLint: airbnb-base code style: prettier github actions status CodeFactor MIT licensed

NPM

Features

Requirements

Structure

.
├── public                      # Express server static path
│   ├── assets                  # All favicon resources
│   ├── locales                 # All of i18n resources
│   └── robots.txt              # A robots.txt file tells search engine crawlers which pages or files the crawler can or can't request from your site.
├── src                         # App source code
│   ├── api                     # All of restful API
│   ├── client                  # Client scope
│   │   ├── app                 # App root component
│   │   ├── assets              # Assets (e.g. images, fonts etc.)
│   │   ├── components          # Reusable components
│   │   ├── pages               # Page components
│   │   ├── stories             # UI components with Storybook
│   │   ├── themes              # App-wide style
│   │   ├── vendor              # 3rd libraries for client
│   │   └── index.js            # App bootstrap and rendering (webpack entry)
│   ├── middlewares             # All of express middleware
│   ├── model                   # Data transfer object
│   ├── mongo                   # MongoDB configuration
│   ├── secure                  # All of security (e.g passport configuration, jsonwebtoken etc.)
│   ├── store                   # Store configuration for both client and server side
│   ├── tools                   # Project related configurations
│   │   ├── jest                # Jest configurations
│   │   ├── webpack             # Webpack configurations
│   │   ├── hooks.js            # Assets require hooks
│   │   └── postcss.config.js   # PostCSS configuration
│   ├── types                   # All of type for flow
│   ├── utils                   # App-wide utils
│   ├── config.js               # Configuration entry point loaded from .env file
│   ├── i18n.js                 # I18next configuration
│   ├── index.js                # App entry point
│   ├── routes.js               # Routes configuration for both client and server side
│   └── server.js               # Express server
│── .babelrc                    # Babel configuration.
│── .env-cmdrc.json             # All of environments configuration.
│── .eslintrc.json              # Eslint configuration.
│── .flowconfig                 # Flow type configuration.
└── .prettierrc.json            # Prettier configuration.

Installation

$ yarn global add express-react-boilerplate
# or (sudo) npm install -g express-react-boilerplate 

Getting Started

1. Usage:

$ erb-gen --help
 
  Usage: erb-gen [options]
 
  Options:
    -v, --version      output the version number
    -d, --dir <type>   project's directory. (default: ".")
    -n, --name <type>  project's name. (default: "express-react-boilerplate")
    -h, --help         output usage information
 
  Examples:
    $ erb-gen
    $ erb-gen --name example

2. Install dependencies:

$ cd <your_project>
 
$ yarn
# or npm install 

3. Run it:

$ yarn dev
# or npm run dev 

Build

$ yarn build
# or npm run build 

NOTE: You can change environment variables in .env-cmdrc.json file.

Scripts

Script Description
dev Start the development server.
dev --serve Start the development server and open browser.
start Start the production server.
build Remove the previous bundled files and bundle it (include client & server) to dist/.
wp Bundle client to dist/.
analyze Visualize the contents of all your bundles.
storybook Start the storybook server.
test Run testing.
eslint Find problems in your JavaScript code.

Enable/Disable offline

  • In src/tools/webpack/webpack.config.prod.js:

    if (isDev) {
      ...
    } else {
      plugins = [
        ...,
        // Comment this plugin if you want to disable offline.
        new OfflinePlugin({
          autoUpdate: true,
          appShell: '/',
          relativePaths: false,
          updateStrategy: 'all',
          externals: ['/'],
        })
      ]
    }

  • At the end of src/client/index.js:

    if (!__DEV__) {
      require('offline-plugin/runtime').install(); // Comment this line if you want to disable offline.
    }

Supported Browsers

By default, the generated project supports all modern browsers. Support for Internet Explorer 9, 10, and 11 requires polyfills. For a set of polyfills to support older browsers, use react-app-polyfill.

$ yarn add react-app-polyfill
# or npm install --save react-app-polyfill 

You can import the entry point for the minimal version you intend to support to ensure that the minimum language features are present that are required to use in your project. For example, if you import the IE9 entry point, this will include IE10 and IE11 support.

Internet Explorer 9

// This must be the first line in <PROJECT_ROOT>/src/client/app/index.js
import 'react-app-polyfill/ie9';
import 'react-app-polyfill/stable';
 
// ...

Internet Explorer 11

// This must be the first line in <PROJECT_ROOT>/src/client/app/index.js
import 'react-app-polyfill/ie11';
import 'react-app-polyfill/stable';
 
// ...

CSS variables

By default, the generated project supports all modern browsers. Support for Internet Explorer 9, 10, and 11 requires polyfills. For a set of polyfills to support older browsers, use css-vars-ponyfill.

// In <PROJECT_ROOT>/src/client/vendor/index.js
import cssVars 'css-vars-ponyfill';
// ... your css/scss files.
cssVars({
  silent: !__DEV__,
  ..., // https://jhildenbiddle.github.io/css-vars-ponyfill/#/?id=options
});

Type Checking For Editor

Contributors

Special Thanks

License

MIT License

Copyright (c) 2019 Huỳnh Trần Đăng Khoa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Readme

Keywords

Package Sidebar

Install

npm i express-react-boilerplate

Repository

github.com/htdangkhoa/erb

Homepage

github.com/htdangkhoa/erb

Weekly Downloads

16

Version

4.2.1

License

MIT

Unpacked Size

199 kB

Total Files

172

Last publish

Collaborators

  • htdangkhoa
Try on RunKit
Report malware