Brunch with Cyclists

An app skeleton for Brunch.

Overview

Brunch builds your app (compiles and concatenates scripts, etc.) and is fast at doing it. Brunch with Cyclists seeds your app structure, including a great JavaScript framework: Cycle.js. It also provides a tiny example app to illustrate how things are hooked together, including tests.

Features

• Cycle.js
• CoffeeScript, with CoffeeLint
• Stylus, with Autoprefixer
• Styledocco
• Automated tests, with notifications, using:
  • Mocha
  • Chai
  • Sinon
  • PhantomJS

Applications

Brunch with Cyclists hooks up a bunch of useful tools and provides opinionated defaults. If these choices work for you you'll find it an excellent starting point for building:

• Stand-alone single-page applications
• The frontend to go with any type of backend web application/server (Express, Rails, Django, ASP.NET, etc.; consider build steps to invoke brunch build --production and copy the contents of public/ to the appropriate assets directory)
• Web views for cross-platform mobile apps (with Cordova, Xamarin, etc.)

Getting started

Requirements

• node
• brunch

Additionally, phantomjs, stylus, and styledocco should be installed globally to make their executables available (for tests and style guide):

npm install -g brunch

Create a project with this skeleton

brunch new gh:drakes/brunch-with-cyclists [optional-output-dir]

Optionally uninstall Brunch global

The brunch global is only required to start a new project; from that point forward everything to build and use the project is installed locally in that project's directories. You may optionally uninstall global brunch afterward:

npm uninstall -g brunch

Build, run tests, and launch a server

npm start

Editing changes should be picked up by brunch automatically in "watch" mode and recompiled, etc., including re-running tests on script changes.

To view the app browse to: http://localhost:3333/

License

Brunch with Cyclists is © Scott Drake and available under the MIT license.