readme.md

April 16, 2013 ยท View on GitHub

A flatiron http server template in coffee-script

based on iron-coffee

by Tom Wilson

Fork black-coffee on Github

About

Black Coffee is a template or boiler-plate to get started writing flatiron web applications in CoffeeScript.

It includes a Cakefile that lets you build, and watch your coffeescript as you develop.

Just hack away at app.coffee in the src directory and create your own
pages. Skeleton CSS framework is included as well as a default skeleton page.

The default CoffeeCup templates for black-coffee are located in the src/pages directory. 3 pages and a layout template are included as examples in addition to the skeleton page.

Assets can be served from the 'assets' directory using ecstatic.

Example Website

Drink your Black Coffee


Technologies

This template uses the following to create nodejs applications


Getting Started

Install nodejs and npm

git clone http://github.com/gradus/black-coffee.git [project-name]
cd [project-name]
npm install .

This is just a template to get you started.

If you want to make this your own project on github:

git remote rm origin
git remote add origin git@github.com:[your github accountname]/[project-name].git

Dependencies

npm install .
npm install flatiron

Black-Coffee currently requires the master version of director

cd node_modules/flatiron
npm uninstall director
npm install git://github.com/flatiron/director.git
cd ../../
Build
cake build
Watch
cake watch
Test

write tests, put them in the test directory and run

cake test
Run
npm start

Thanks