Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 2.46 KB

README.md

File metadata and controls

64 lines (49 loc) · 2.46 KB

CircleCI codebeat badge Dependency Status Dependency Status

Features

  • Webpack 4
    • Transpiles .js files using Babel 7 (settings in .babelrc)
    • Transpiles .scss files using node-sass
    • ESLint - Lints js files on changes (rules in .eslintrc)
    • Stylelint - Lints scss files on changes (rules in .stylelintrc)
    • PostCSS plugins (settings in postcss.config.js)
      • Autoprefixer (supported browsers list in browserslist file)
      • cssnano - To compress the resulting CSS
    • Dynamic index.html generation
    • Dynamic build file names with hash for cache busting
    • Automatically builds a vendor bundle with all packages imported from node_modules
  • React
    • React Hot Loader v4 - Simplified hot reloading setup
    • React Router v4
      • HTML5 History API (non hash routes)

Getting Started

  1. Install Node.js (choose Current)

  2. git clone or Download this repo

  3. Update the README to your needs

  4. Install dependencies (at the root of the repo):

    npm install
    

Development

Run webpack-dev-server

npm start
  • Open http://localhost:8080

Build the project for deployment

npm run build
  • Must use a server that serves missing routes as index.html

To run the build locally

npm i -g serve
serve -s dist