https://github.com/foxbunny/create-coffee

CoffeeScript & Compass Project Template
https://github.com/foxbunny/create-coffee

Last synced: 28 days ago
JSON representation

CoffeeScript & Compass Project Template

• Host: GitHub
• URL: https://github.com/foxbunny/create-coffee
• Owner: foxbunny
• Created: 2013-10-10T07:26:55.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-18T13:56:12.000Z (about 11 years ago)
• Last Synced: 2023-03-10T22:13:37.753Z (almost 2 years ago)
• Language: JavaScript
• Size: 328 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CoffeeScript & Compass Project Template

This web project has the following setup:

* coffee/ - CoffeeScript sources

    * app.coffee - the top-level config script source

    * app/ - the directory to store project-specific sources

* sass/ - Compass/SCSS sources

* www/ - the web assets for the project

    * index.html - the entry point into the app.

    * js/

        * app.js - the top-level config script used by index.html

        * app/ - the directory to store project-specific scripts.

        * lib/ - the directory to hold third party scripts.

    * css/ - the directory to hold compiled CSS

* tools/ - the build tools to optimize the project.

    * build.js - build configuration

    * proxy.json - development server configuration

    * compass.rb - Compass configuration

## Before you start

Please install the development tools using npm in the project directory:

    npm install

Volo must be installed globally:

    npm install -g volo

## Adding third-party libraries

To add third-party libraries use the [volo

add](https://github.com/volojs/volo/blob/master/commands/add/doc.md) command.

**Do not manually copy dependencies into `www/js/lib`.**

## Starting the development server

To start the server run:

    volo serve

## Building the project

To optimize, run:

    volo build

This will run the "build" command in the volofile that is in this directory.

That build command creates an optimized version of the project in a

**www-built** directory. The js/app.js file will be optimized to include

all of its dependencies.