Skip to content

Latest commit

 

History

History
190 lines (125 loc) · 5.18 KB

README.markdown

File metadata and controls

190 lines (125 loc) · 5.18 KB
Raw

CoffeeApp -- coffee-script wrapper for CouchApp

DEPRECATED:

this application is not needed any more, couchdb handling of coffeescript natively.

The Change Log

(http://thechangelog.com/coffeeapp-coffee-script-wrapper-for-couchapp/)

Installing

Prerequisites: CouchApp (pip install couchapp) couchdb (pip install couchdb) - used for dump / restore requires Node.js (http://nodejs.org/) - tested on v0.2.6 Npm (http://npmjs.org/)

Get CoffeeApp:

git clone git://github.com/andrzejsliwa/coffeeapp.git

Build CoffeeApp:

cd coffeeapp && make && sudo make install

Installing with npm

npm install coffeeapp

Or, get the code, and npm link in the code root.

Basic usage

coffeeapp [couchapp options] | [wrapped options]

Example usage

without compilation errors:

$ coffeeapp push

CoffeeApp (v1.1.0) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

Wrapping 'push' of couchapp
preparing .releases/20101008202459 release...
 * processing filters/filter.coffee...

done.
2010-10-08 20:25:04 [INFO] Visit your CouchApp here:
http://127.0.0.1:5984/tutorial/_design/hello/index.html

with errors, all generated files have in content '...' which should be replaced by real code - this helps to keep clean project ;) :

$ coffeeapp push
CoffeeApp (1.1.0) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

Wrapping 'push' of couchapp
Database : 'default'
making dump: .dumps/default/20101202172115
 * linking dump: .dumps/default/20101202172115 -> .dumps/default/last
preparing release: .releases/20101202172115
 * processing views/coffewview/reduce.coffee...
Compilation Error: Parse error on line 1: Unexpected '.'

using coffee generators

$ coffeeapp cgenerate view myview

CoffeeApp (v1.1.0) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

Running CoffeeApp 'view' generator...
 * creating myview/map.coffee...
 * creating myview/reduce.coffee...
done.

using prepare command:

$ coffeeapp prepare
CoffeeApp (v1.1.0) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

preparing project:
 * creating .gitignore...
done.

using clean command:

$ coffeeapp clean
CoffeeApp (v1.0.5) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

cleaning up:
 * remove '.releases' ...
done.

using restore - available only when using make_dumps in .couchapprc

CoffeeApp (1.1.0) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

 * restoring dump from .dumps/default/last to database:
done.

using help command:

$ coffeeapp help

...
CouchApp Help here ...
...

CoffeeApp (1.1.0) - simple coffee-script wrapper for CouchApp (http://couchapp.org)
http://github.com/andrzejsliwa/coffeeapp

Usage: coffeeapp [OPTIONS] [CMD] [CMDOPTIONS] [ARGS,...]

Commands:
        help      [OPTIONS]...
                  show this message

        cgenerate [OPTIONS]...
                  [ view | list | show | filter ] generate .coffee versions

        destroy   [OPTIONS]...
                  [ view | list | show | filter ] destroy (remove directory/files also .js files).

        prepare   [OPTIONS]...
                  prepare (.gitignore...)

        clean     [OPTIONS]...
                  remove .releases & .dumps directories

        restore   [OPTIONS]...
                  restore database from .dumps/last

using make_dump option in .couchapprc

{
  "env" : {
    "default" : {
      "db" : "http://127.0.0.1:5984/krotco",
      "make_dumps": true
    }
  }
}

using makeReleaseVersions and designdocName options in .couchapprc for controlling whether a unique release with a timestamp is pushed or an update to a static design document. designdocName has the default value "app".

{
  "env" : {
    "default" : {
      "db" : "http://localhost:5984/default",
      "make_dumps": false
    }
  },
  "makeReleaseVersions": false,
  "designdocName": "Proggis"
}

Description

CoffeeApp is a simple wrapper for couchapp command. CoffeeApp override normal push behavoir, by adding '.releases' directory which contain deployment snapshots (timestamped). While files are copied to release snapshot... coffee-script files (.coffee) are converted on the fly to java-script (.js) files.

'.releases' directory should be added to .gitignore or .hgignore or whatever you have using to prevent versioning.

TODO

  • add coffeescript project initialization(install compressed coffeescript for frontend, add gitignores and etc..)
  • add application testing stuff - still open how to do that

Author

Andrzej Sliwa, andrzej.sliwa@i-tool.eu

Contributors

Josh Bohde, josh.bohde@gmail.com Szaby Grünwald, https://github.com/szabyg