README.md

React Static Boilerplate

Directory Layout

.
├── /build/                     # The folder for compiled output
├── /node_modules/              # 3rd-party libraries and utilities
├── /components/                # React components
├── /core/                      # Core framework
├── /pages/                     # React.js-based web pages
│   ├── /404.js                 # Not Found page
│   ├── /500.js                 # Error page
│   └── /index.js               # Home / Submit page
├── /static/                    # Static files such as favicon.ico etc.
├── /test/                      # Unit and integration tests
├── /tools/                     # Build automation scripts and utilities
│── app.js                      # The main JavaScript file (entry point)
│── config.js                   # Website configuration / settings
│── LICENSE.txt                 # License file
│── package.json                # Dev dependencies and NPM scripts
└── README.md                   # Project overview

Getting Started

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

$ git clone -o cfa-dance -b master --single-branch \
      https://github.com/keithk/cfa-dance.git DanceParty
$ cd DanceParty
$ npm install
$ npm start

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

How to Test

The unit tests are powered by chai and mocha.

$ npm test

How to Deploy

I currently have a github pages set up here, so PR your changes and they'll be pushed automagically.

$ npm run deploy                # Deploys the project to GitHub Pages

Learn More

• Getting Started with React.js
• Getting Started with GraphQL and Relay
• React.js Questions on StackOverflow
• React.js Discussion Board
• Learn ES6, ES6 Features

---

Used boilerplate from react-static-boilerplate with 💖