Skip to content
This repository was archived by the owner on Dec 24, 2025. It is now read-only.

osminogin/express-coffee-seed

Repository files navigation

Express Coffee Project Seed (0.4.3)

unmaintained Build Status Dependency Status

NOTE: This project is unmaintained.

If you want to develop it, don't issue pull requests, but create your own fork. Thanks!

Introduction

Project seed for Node.js/Express/CoffeeScript stack originally based on Tom Wilson's coffee-express template, but use Sequelize ORM (working with MySQL, MariaDB, SQLite and PostgreSQL databases) and have a better CoffeeScript support.

It comes ready to go with connect-assets that give you the option to use coffee-script and stylus for the client side. (This feature temporarily disabled for much quickly tests passing)

Technologies

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

  • Node v0.10.x
  • Express v4.5.x
  • CoffeeScript v1.7.x
  • Sequelize v1.7.x
  • Bootstrap 3.2.x (not a npm module)
  • Connect Assets v3.0.x
  • Angular v1.2.x
  • Jade v1.3.1

Requirements

These requirements will install with NPM and Bower, just do

$ bower install
$ npm install

In your project directory.


Install, Build, Run, Test, and Watch

Install nodejs and npm

$ git clone https://github.com/osminogin/express-coffee-seed.git [project-name]
$ cd [project-name]
$ npm install

Install coffee-script and mocha

$ npm install -g coffee-script
$ npm install -g mocha

Start server

$ cake run

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 test suite

$ 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

About

express-coffee-seed is a boilerplate to get started writing new express web applications in Coffee Script. It comes ready to go with base setup for an Express Web App.

It includes a Cakefile that lets you build, test, and watch Coffee Scripts as you develop.

You hack in the ./src folder and run cake build to build you server files, write your mocha tests in your ./test folder and run cake test to run your test suite.

Create your jade views in the ./views folder and put your public assets in the ./public

License

MIT

About

Starter template for Node.js app using Express, CoffeeScript and Angular

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors