Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.05 KB

README.md

File metadata and controls

61 lines (44 loc) · 2.05 KB
Raw

React Boiler Plate (Front end starter)

Live Demo

This starter has a basic setup for

  • webpack
  • .eslintrc.js
  • .prettierignore
  • netlify.toml
  • postcss.config.js
  • robots.txt
  • .babelrc
  • .vscode/extensions.json (Recommended extensions)
  • redux
  • an email form with EmailJS
  • image optimization and conversion to Webp using sharp
  • bootstrap
  • react-router
  • react-helmet
  • page header
  • page footer
  • social media share buttons
  • a carousel

Use of this starter template assumes that you have a 'complete dev environment' setup - a terminal, Node, VS Code, at least. If not, you may want to start here.

What's Included

  • code style: prettier
  • ESLint with xo style guide
  • Stylelint for CSS linting. I am including the 'standard configuration' with some additional rules to keep things alphabetical, indented with 2 spaces, etc.
  • husky will check over code quality with the linters b4 there is a successful commit.
  • Various VS Code 'settings' and 'extensions.' Look in the bottom right when you open this up in VS Code to install them.
  • image optimization using Sharp (Size must be specified in convert.js)

How To Use

All new images must be converted inside ./convert.js. npm must be restarted in development mode for the new images to be converted

Run npm i to get all the things installed.

Run in development mode

npm start

Build and run production mode

serve must be installed with npm install -g serve

After serve is installed you can build with

npm run-script build

and then serve this build with

npm run-script serve

Lighthouse

Lighthouse Score