thegecko/spa-skeleton

Single-Page Appication Skeleton

SPA Skeleton

Single-Page Application Skeleton

Architecture

Development

• package manager: npm
• task runner: gulp
• es2015 transpiler: babel
• module loader: webpack

Structure

• ajax: jQuery
• components: react
• state container: redux
• redux glue: react-redux

Routing

• routing: react-router
• redux glue: react-router-redux

Styling

• layout: foundation-sites
• css pre-processor: sass

Testing

• linting: eslint
• runner: mocha + chai
• reporter: mochawesome

Deployment

• continuous integration: circleci
• staging server: gh-pages

Online Books

• backbone: backbone apps
• webpack + react: survivejs

Prerequisites

Node.js which includes npm.

gulp installed globally by running:

> npm install -g gulp

Installing

After cloning this repository, install the npm dependencies:

> npm install

Development

Simply use the default gulp task to lint the code, run tests and start a live-reloading web-server:

> gulp

Building

Use the build gulp task to lint the code, run tests and create a production-ready package in the dist folder:

> gulp build

Staging

Successful CircleCI builds are automatically deployed to gh-pages