Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twilson63/express-coffee
A Template for NodeJs Application using Express, CoffeeScript, Jade, Stylus, Nib
https://github.com/twilson63/express-coffee
Last synced: 3 months ago
JSON representation
A Template for NodeJs Application using Express, CoffeeScript, Jade, Stylus, Nib
- Host: GitHub
- URL: https://github.com/twilson63/express-coffee
- Owner: twilson63
- License: mit
- Created: 2010-06-26T10:16:18.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2020-09-04T22:49:02.000Z (about 4 years ago)
- Last Synced: 2024-05-22T18:32:10.201Z (6 months ago)
- Language: CoffeeScript
- Homepage: http://twilson63.github.io/express-coffee
- Size: 1.66 MB
- Stars: 626
- Watchers: 31
- Forks: 152
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- Changelog: history.md
- License: LICENSE
Awesome Lists containing this project
README
# Express Coffee Template 9 (1.9.0)
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 v4.2.x
* Express v4.13.x
* CoffeeScript v1.10.x
* Jade v1.11.0
* Stylus v0.52.x
* bootstrap-stylus 2.3.1 (not a npm module)
* Nib v1.1.x
* Connect Assets v2.5.x
* MongoDB / Mongoose 3.8.x
## Requirements
* [NodeJs](http://nodejs.org)
* [Express](http://expressjs.com)
* [CoffeeScript](http://coffeescript.org)
* [Jade](http://jade-lang.com/)
* [Stylus](http://learnboost.github.io/stylus/)
* [bootstrap-stylus](https://github.com/Acquisio/bootstrap-stylus)
* [Nib](http://visionmedia.github.io/nib/)
* [connect-assets](http://github.com/TrevorBurnham/connect-assets)
* [Mocha](http://mochajs.org/)
* [Mongoose](https://github.com/LearnBoost/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
``` sh
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://mochajs.org/](http://mochajs.org/)
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](https://github.com/jashkenas) for creating coffee-script
* [TJ Holowaychuk](https://github.com/visionmedia) for creating express
* [Miško Hevery](https://github.com/mhevery) for creating Jasmine-Node
* [TJ Holowaychuk](https://github.com/visionmedia) 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