Documentation

Getting started

Quick start

To install leaves, run

$ npm install -g leaves

If npm install fails, try to use sudo.

Then, to install some extra dependencies automatically and setup the shell completion, run

$ leaves setup

to start a new project

$ leaves new project_name
$ cd project_name
$ leaves

and start coding!

Get a project from Git

$ leaves get https://github.com/me/my_leaves_project.git
$ cd my_leaves_project
$ leaves

and start coding!

Main functionalities

  • HTML templating via Jade or EJS
  • CSS templating via Stylus or less
  • CoffeeScript compilation
  • Project watch and livereload
  • Scripts and stylesheets globbing with **/*.js like syntax
  • Compile error displayed in browser
  • Single command deploy to Heroku and GitHub pages, and FTP servers
  • Simple internationalization support
  • Misc: lorem-ipsum generator, easy CDN usage, shell completion, single command upgrade, dev mode

Structure

The app has the following structure:

.
├── assets
│   ├── css
│   │   ├── .keep
│   │   └── main.styl
│   ├── favicon.ico
│   ├── img
│   │   └── .keep
│   └── js
│       ├── app.coffee
│       └── .keep
├── bower.json
├── .bowerrc
├── .gitignore
├── .gruntfile.coffee
├── .leavesrc
├── .leavesrc.local
├── package.json
└── views
    ├── index.jade
    └── layout.jade

when running leaves, views and assets are watched, compiled or copied on change and your browser is reloaded.