americano-cozy

Americano helpers to build Cozy applications faster

npm install americano-cozy
74 downloads in the last day
316 downloads in the last week
1 155 downloads in the last month

Americano Cozy

When you want to write Cozy applications with Americano, you don't have the good helpers to write your models. Here are some that could make your life easier, notably about declaring your requests.

Getting Started

Add americano-cozy to the list of your plugins in the Americano configuration file. Then add it as a dependency of your project:

npm install americano-cozy -g

Models

Do no think about including JugglingDB and its configuration for Cozy anymore, Americano Cozy does the job for you:

americano = require 'americano-cozy'

module.exports = americano.getModel 'Task',
    done: Boolean
    completionDate: Date

Requests

Describe your Data System requests in a single file:

# server/models/requests.coffee
americano = require 'americano-cozy'

module.exports =
    task:
        all: americano.defaultRequests.all
        analytics:
            map: (doc) ->
                if doc.completionDate? and doc.done
                    date = new Date doc.completionDate
                    dateString = "#{date.getFullYear()}-"
                    dateString += "#{date.getMonth() + 1}-#{date.getDate()}"
                    emit dateString, 1
            reduce: (key, values, rereduce) ->
                sum values

What about contributions?

Here is what I would like to do next:

  • write tests
  • remove async from the dependency (use recursive functions instead)
  • make Data System URL configurable

I didn't start any development yet, so you're welcome to participate!

npm loves you