Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Data Layer for Cozy Platform
CoffeeScript

README.md

Cozy Data System

Little API that act as a middleware between Cozy Platform applications and data sent to the database, to the indexer and to the file system. It manages application permissions and provide helpers to make Cozy app development easier.

Install

To set it up inside your cozy instance:

# Get cozy monitor
npm install cozy-monitor -g
cozy-monitor install data-system

Contribution

You can contribute to the Cozy Data System in many ways:

  • Pick up an issue and solve it.
  • Add bulk features.
  • Improve mass deletion.
  • Write new tests.

Hack

Install CouchDB (>= 1.2.0), NodeJS (>= 0.8.0) then:

git clone git://github.com/mycozycloud/cozy-data-system.git
cd cozy-data-system

# Load dependencies
npm install

Once datasystem is installed, run it with:

npm start # performs a node build/server.js

Or you can start it in dev mode with:

coffee server.coffee

Tests

Build
Status

Run tests with following commmand

cake tests

Before submitting a pull request

  • Make sure the tests pass
  • Make sure you've built your modification:
cake tests
cake check-build
cake build

You can also use the provided hook:

cp pre-push .git/hooks/

About code coverage

The cake coverage command requires a bit of explanation. To achieve a proper code coverage, all CouchDB requests must be written in full javascript, otherwise the tests cannot work (since the coffee source is compiled with a special version).

License

Cozy Data System is developed by Cozy Cloud and distributed under the AGPL v3 license.

What is Cozy?

Cozy Logo

Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.

Community

You can reach the Cozy Community by:

  • Chatting with us on IRC #cozycloud on irc.freenode.net
  • Posting on our Forum
  • Posting issues on the Github repos
  • Mentioning us on Twitter
Something went wrong with that request. Please try again.