Minimal React.js boilerplate with an auto build environment for Windows
JavaScript CSS HTML
Pull request Compare This branch is 5 commits ahead, 1 commit behind jeffbski:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
public
src
.babelrc
.eslintrc
.gitignore
.npmignore
LICENSE
README.md
bs-config.js
package.json

README.md

This is a minimal React.js boilerplate with an auto build environment for Windows which you can fork and clone to easily setup your own projects.

Use git to clone or download the zip from GitHub and run npm install

This boilerplate is specifically for Windows users. Non-windows users should see https://github.com/codewinds/base-react-min

TODO: Replace this boilerplate with your project description

Features:

  • Windows support - Tested on WinXP, should work on anything newer. Also works with msys (but not required). Only restriction is that needs to use local drives, not network drives.
  • React.js JSX example which fetches from REST source and renders
  • simple build and auto rebuild (watch) using npm run scripts
  • browser-sync for auto reloading in browser on change
  • ES6/7 and JSX compiling to ES5 with babeljs
  • eslint for linting
  • browserify (w/babelify) for bundling javascript for the browser
  • watchify to automatically rebuild on changes
  • uglify for js minification
  • less CSS style compiler
  • cleancss for css minification
  • axios for promise based HTTP client

Structure:

  • package.json - dependencies and build commands
  • public/index.html - main HTML
  • public/fake-api.json - mock REST api returning json data
  • src/browser.jsx - React.js JSX code which fetches REST data and renders into the main HTML
  • src/util/polyfill.js - Import any core-js or other polyfills here
  • assets/site.less - CSS styles used by site, edit or import into
  • bs-config.js - browser-sync config, set browser to launch
  • dist/ - contains compiled and minified css and js

Notes:

  • My default browser for browser-sync is Google Chrome, if you want to use a different browser like Google Chrome Canary or Mozilla Firefox edit bs-config.js

Installation

Requires node.js/iojs >= 0.10

npm install ## install dependent node modules

Usage

TODO: update with your usage

Primary use - auto build and reload browser

npm run watch # build and watch, auto recompile and load changes
# use control-c to exit the autobuild watch

Build only

npm run build # build only

Build for Production

npm run prod-build # sets NODE_ENV=production then builds

Goals

TODO: Add your goals here

Why

TODO: Add your description of why you created this

Get involved

If you have input or ideas or would like to get involved, you may:

License