Import data in your Cozy
CoffeeScript JavaScript CSS Other
Latest commit 4d5d51f Feb 17, 2017 @ZeHiro ZeHiro committed on GitHub Update README.md

README.md

Travis build status shield NPM release version shield Github Release version shield NPM Licence shield

Build Status

Cozy MyAccounts

What's Cozy?

Cozy Logo

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

What's MyAccounts (previously known as Konnectors)?

Collection of connectors to fetch data from different websites and save them into your Cozy.

Available connectors

The connectors marked with are known as currently broken.

Bills

Website Data Maintainer Status
Ameli PDF Gara64
APRR PDF SomeAverageDev
Bouygues Box PDF doubleface (#498)
Bouygues Telecom Mobile PDF doubleface (#498
Captain Train PDF ZeHiro
Darty PDF ZeHiro
Digital Ocean PDF Frank Rousseau
Direct Energie PDF bnjbvr
Electrabel PDF ZeHiro (looking for a maintainer with credentials)
Free PDF ZeHiro
Free Mobile PDF ZeHiro
Github PDF doubleface
Malakoff Mederic PDF Gara64
Materiel.net PDF nicofrand
Numéricable PDF nicofrand
OVH CA PDF Chocobozzz (needs an app token)
OVH EU PDF Chocobozzz ⚠️ (issue on first import)
SoYouStart CA PDF Chocobozzz (needs an app token)
SoYouStart EU PDF Chocobozzz
Kimsufi CA PDF Chocobozzz (needs an app token)
Kimsufi EU PDF Chocobozzz (needs an app token)
Runabove PDF Chocobozzz ⚠️ (issue on first import)
Online.net PDF Chocobozzz
Orange PDF Frank Rousseau ⚠️ (only for individual account)
Sosh PDF Frank Rousseau ⚠️ (only for individual account)
SFR box PDF creator:doubleface
SFR mobile PDF creator:doubleface, nicofrand
Virgin mobile PDF nicofrand (looking for a maintainer with credentials)
Uber PDF ZeHiro
Vente-privée.com PDF SomeAverageDev ⚠️ (only the last bill)

Internet Of Things

Website Data Maintainer Status
Jawbone Move and Sleep data looking for a maintainer with credentials
Nest Temperatures looking for a maintainer with credentials
Withings Weight, Heartbeat and Blood Presure data looking for a maintainer with credentials ⚠️ (#352, #260)

Social

Website Data Maintainer Status
Github Commits doubleface
Twitter Published tweets doubleface
Linkedin contact information Peltoche (#396)
Google contact information jacquarg ⚠️(#541)

Events

Website Data Maintainer Status
Ical Feed Events Cozy
Contact Birthdays Events Frank Rousseau
Doctolib Events ZeHiro
Facebook Events jacquarg ⚠️ (#420)
SNCF Events Chocobozzz
Google Events Cozy
Isen Events, lessons Cozy
Meetup Events JbIPS

Productivity

Website Data Maintainer Status
RescueTime Activites looking for a maintainer with credentials

Hobbies

Website Data Maintainer Status
Podcasts Audio podcasts episodes Babolivier

Hack

Install and run in dev mode

Hacking the MyAccounts app requires you to setup a dev environment.

You can then clone the app repository and install dependencies:

$ git clone https://github.com/cozy-labs/konnectors.git
$ cd konnectors
$ npm install

📌 If you use a node environment wrapper like nvm or ndenv, don't forget to set your local node version before doing a npm install.

Cozy's apps use a standard set of npm scripts to run common tasks. You can so start you development workflow with:

$ cd konnectors
$ npm run watch

and point your browser to http://localhost:9358.

For more information about how to build konnectors, just take a look at our wiki.

Run it inside the VM

You can easily view your current running app in your VM, use cozy-dev:

# in a terminal, run your app in watch mode
$ cd konnectors
$ npm run watch
# in another terminal, install cozy-dev (first time) and run the deploy
$ cd konnectors
$ npm install -g cozy-dev
$ cozy-dev deploy 9358

your app is available in your vm dashboard at http://localhost:9104.

Tests

Tests are run by mocha under the hood, and written using chai and sinon. You can easily run the tests suite with:

$ cd konnectors
$ npm run test

📌 Don't forget to update / create new tests when you contribute to code to keep the app the consistent.

Models

The Cozy datastore stores documents, which can be seen as JSON objects. A doctype is simply a declaration of the fields in a given JSON object, to store similar objects in an homogeneous fashion.

Cozy ships a built-in list of doctypes for representation of most of the common documents (Bills, Contacts, Events, ...).

Whenever your app needs to use a given doctype, you should:

  • Check if this is a standard doctype defined in Cozy itself. If this is the case, you should add a model declaration in your app containing at least the fields listed in the main fields list for this doctype. Note that you can extend the Cozy-provided doctype with your own customs fields. This is typically what is done in Konnectors for the Bill doctype.
  • If no standards doctypes fit your needs, you should define your own doctype in your app. In this case, you do not have to put any field you want in your model, but you should crosscheck other cozy apps to try to homogeneize the names of your fields, so that your doctype data could be reused by other apps. This is typically the case for the Konnector doctype in Konnectors.

Resources

All documentation is located in the /docs app directory. It provides an exhaustive documentation about workflows (installation, development, pull-requests…), architecture, code consistency, data structures, dependencies, and more.

Feel free to read it and fix / update it if needed, all comments and feedback to improve it are welcome!

Open a Pull-Request

If you want to work on MyAccounts and submit code modifications, feel free to open pull-requests! See the contributing guide for more information about how to properly open pull-requests.

Community

Localization

Localization and translations are handled by Transifex, which is used by all Cozy's apps.

As a translator, you can login to Transifex (using your Github account) and claim an access to the app repository. Locales are pulled when app is build before publishing.

As a developer, you must configure the transifex client, and claim an access as maintainer is the app repository. Then please only update the source locale file (usually en.json in client and/or server parts), and push it to Transifex repository using the tx push -s command.

Maintainer

The lead maintainers for MyAccounts is @m4dz for Cozy Cloud, and @ZeHiro, @doubleface and @nicofrand for the community ; send them a 🍻 to say hello!

Get in touch

You can reach the Cozy Community by:

License

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