sirithink / express-coffee

A Template for NodeJs Application using Express, CoffeeScript, Jade, Stylus, Nib

Express Coffee Template 8 (1.8.1)

This is a Node Express CoffeeScript Stack Template

It comes ready to go with connect-assets that give you the option to use coffee-script and stylus for the client side.

Technologies

This is a template that can be used to create nodejs applications using

• Node v0.10.x
• Express v3.2.x
• CoffeeScript v1.6.x
• Jade v0.30.0
• Stylus v0.32.x
• bootstrap-stylus 2.3.1 (not a npm module)
• Nib v0.9.x
• Connect Assets v2.4.x
• MongoDB / Mongoose 3.6.x

Requirements

• NodeJs
• Express
• CoffeeScript
• Jade
• Stylus
• bootstrap-stylus
• Nib
• connect-assets
• Mocha
• Mongoose

These will install with npm, just do

npm install

In your project directory.

---

Install, Build, Run, Test, and Watch

# Install nodejs and npm

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

Install coffee-script, mocha and docco

npm install coffee-script -g
npm install mocha -g
npm install docco -g

Run

cake dev

Mocha and Request for testing

mocha is an extremely powerful and easy to use testing framework

see http://visionmedia.github.com/mocha/

describe 'Sample test', ->
  it 'should be true', ->
    true.should.equal true

to run mocha

cake test

Setup to deploy to heroku

rm -rf .git
git init
echo 'node_modules' >> '.gitignore'
git add .
git commit -am "first commit"
heroku create
git push heroku master
heroku open

Thanks to

• Jeremy Ashkenas for creating coffee-script
• TJ Holowaychuk for creating express
• Miško Hevery for creating Jasmine-Node
• TJ Holowaychuk for creating mocha and should.js

About

express-coffee is a template or boiler-plate to get started writing express web applications in CoffeeScript. It comes ready to go with base setup for an Express Web App. It includes a Cakefile that lets you build, spec, and watch your coffeescript as you develop. You hack in the src folder and run cake build to build you server files, write your mocha in your test folder and run cake test or spec to run your test suite. Create your jade views in the views folder and put your public assets in the public folder. Enjoy your express-coffee

License

See LICENSE

Contribute

pull requests are welcome