React pages boilerplate

This boilerplate introduces a simple way for developing serverless React applications, which are perfect for serving from Github Pages.

Technologies

• Webpack@3 as module bundler
• Babel for js and jsx transpiling
• react-hot-loader@3 for extremely fast hot updates
• Eslint and Stylelint for linting
• Tape and Enzyme for testing
• Sass, PostCSS and Autoprefixer for styles processing
• Storybook for painless UI development and testing

Preinstalled and configured libraries

• react@16
• redux
• react-router@4 with HashRouter (perfectly suits Github Pages environment)
• react-redux
• axios with redux-axios-middleware
• ramda and lodash as an utility libraries (unused parts will be cut off with babel and webpack plugins)
• react-icons

Getting started

• Clone git clone https://github.com/rtivital/react-pages-boilerplate or download this repository.
• Install dependencies: npm install
• Run the project: npm start
• Remove git folder with npm run clean:git (this will remove .git folder attached to react-pages-boilerplate) and follow these instructions to init new Github repository and enable publishing to Gihub Pages.

npm scripts

• npm start – starts development server with webpack-dev-server
• npm test – runs tape with babel-register
• npm run build – builds project to production (Note that the result bundle is not suitable for hosting on Github Pages, use npm run deploy to build and deploy to Github Pages)
• npm run deploy – builds and deploys project to Github pages
• npm run lint – lints both JavaScript (with npm run lint:js) and Sass files (with npm run lint:scss)
• npm run storybook – starts storybook server on port 9001