Web & Mobile boilerplate for node/express
JavaScript CoffeeScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
lib
logs
public
src
test
views
.gitignore
Cakefile
README.md
app.js
license.txt
package.json

README.md

Colada

Web & Mobile boilerplate for node/express

How to use

  • Coming soon

The Stack

File Structure

  • app.js: Main app file, run node app.js to start app
  • public/: Public folder, all front-end files go here
    • css
    • img
    • js
  • lib/: All backend files go here
  • test/: Where all tests are. Currently uses Vows as example
  • views/: Where all Jade templates are
    • mobile
    • www
  • src/: Source files, where all Coffeescript and Stylus file resides. The file structure within src/ folder mirrors the root folder, saves time trying to hunt for files
  • docs/: Docco generated documentation files

Compiling Files

There are a couple of helper functions defined within the Cakefile, which are:

cake watch                # Watches all Coffeescript(JS) and Stylus(CSS) files
cake watchJS              # Watches all coffeescript files for changes
cake watchCSS             # Watches all CSS files for changes
cake compileJS            # Compiles all Coffeescript files into JS
cake test                 # Runs all tests
cake docs                 # Create documentation using Docco

To run Cakefile remember to install coffee-script as a global module,

npm install coffee-script -g

To compile the CSS you need to install stylus as a global module too in order to run the executable:

npm install stylus -g

Then, at the root folder, just do

cake watch

And magic happens! :)