ywt-web

React Static Boilerplate

A static website starter kit powered by React.js and Webpack.

Join #react-static-boilerplate chatroom on Gitter to stay up to date.

Features

    ✓ Generates static .html pages from React components
    ✓ Generates routes based on the list of files in the /src folder
    ✓ Next generation JavaScript with Babel
    ✓ Next generation CSS with postCSS and cssnext
    ✓ Development web server with React Hot Loader
    ✓ Bundling and optimization with Webpack
    ✓ Code-splitting and async chunk loading
    ✓ Easy deployment to GitHub Pages or Amazon S3
    ✓ Yeoman generator (generator-react-static)

Getting Started

Just clone the repo, install Node.js modules and run npm start:

$ git clone -o react-static-boilerplate -b master --single-branch \
      https://github.com/koistya/react-static-boilerplate.git MyApp
$ cd MyApp
$ npm install
$ npm start

Then open http://localhost:3000/ in your browser.

Directory Layout

.
├── /build/                     # The folder for compiled output
├── /node_modules/              # 3rd-party libraries and utilities
├── /src/                       # React.js-based web pages
│   ├── /blog/                  # Blog post entries example
│   ├── /img/                   # Website images
│   ├── /js/                    # JavaScript code and React.js components
│   ├── /404.js                 # 'Not found' page
│   ├── /about.js               # 'About' page
│   └── /index.js               # 'Home' page
├── /test/                      # Unit tests
├── /tools/                     # Build automation scripts
│── LICENSE.txt                 # License file
│── package.json                # Dev dependencies and NPM scripts
└── README.md                   # Project overview

How to Test

The unit tests are powered by chai and mocha.

$ npm test

How to Deploy

$ npm run build -- --release    # Builds the project in release mode
$ npm run deploy                # Deploys the project to GitHub Pages

How to Update

You can always fetch and merge the recent changes from this repo back into your own project:

$ git checkout master
$ git fetch react-static-boilerplate
$ git merge react-static-boilerplate/master
$ npm install

Related Projects

• React Starter Kit
• React Routing
• React Decorators

Learn More

• Getting Started with React.js
• React.js Wiki on GitHub
• React.js Questions on StackOverflow
• React.js Discussion Board
• Learn ES6, ES6 Features

---

Made with ♥ by Konstantin Tarkus (@koistya) and contributors  |  MIT License