A React and Redux boilerplate with hot reloading, SASS compiling and provides a clean starting point for building applications.
For the TypeScript version check out tsrr-boiler.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You will need node, and either npm or yarn installed for managing packages.
Check if they are installed by entering the following in console:
$node -v
$npm -v
$yarn -v
Clone the repository to your local machine
git clone https://github.com/LiamRoss/srr-boiler.git
Finally, run your preferred package installer
This will install your package.json dependencies, and your project will be ready to build!
The scripts section is borrowed and revised from Facebook's create-react-app page.
Runs the app in development mode. Open http://localhost:3000 to view it in the browser.
You will see the build errors and lint warnings in the console.
Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.
Jest will look for test files with any of the following popular naming conventions:
- Files with
.js
suffix in__tests__
folders. - Files with
.test.js
suffix. - Files with
.spec.js
suffix. - Any of the above with jsx in place of js
Deployment will generate a minified build within your project folder. This build is exluded from git.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes. By default, it also includes a service worker so that your app loads from local cache on future visits.
- create-react-app - The starting point for building this boilerplate
- Webpack 2 - For building and bundling
- Jest - The testing framework
- Liam Ross GitHub - LiamRoss
- Initialized boilerplate