Ecolyo

What's Ecolyo?

Ecolyo is a mobile-first app allowing citizen to visualise easily their energy consumption (electricity, gas, water ...). The app allow simple and more advanced data visualisation but give also some tips on how to reduce energy consumption.

Hack

📌 Note: we recommend to use Yarn instead of NPM for package management. Don't hesitate to install and use it for your Cozy projects, it's now our main node packages tool for Cozy official apps.

Install

Hacking the Cozy LyonLivingLabEnergy app requires you to setup a dev environment.

You can then clone the app repository and install dependencies:

$ git clone https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo.git
$ cd ecolyo
$ yarn install

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

Cozy's apps use a standard set of npm scripts to run common tasks, like watch, lint, test, build…

Run it inside a default Cozy using Docker

First of all get cozy dev image :

$ docker pull cozy/cozy-app-dev

Then you can run your application inside a Cozy thanks to the cozy-stack docker image:

# in a terminal, run your app in watch mode with a docker running Cozy
$ cd ecolyo
$ yarn start

After the build and the stack launched, your app is now available at http://ecolyo.cozy.tools:8080.

Run it inside custom Docker

For the project we have created our own docker container. For more information on how to use it, please refer to wiki section.

Tests

Tests are run by jest under the hood. You can easily run the tests suite with:

$ cd ecolyo
$ yarn 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, Files, ...).

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.

Open a Pull-Request

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

Commits and releases

This app uses the standard-version module to release version automatically.

You must follow these rules to write your commit messages : Conventional Commits Specification

To make a new release, bump the version in the package.json and create a Git tag, use the following command depending on the needs :

• yarn release --first-release to make the first release (will not bump the version).
• yarn release to automatically bump the version based on the last commit types.
• yarn release --prerelease alpha to make a pre-release suffixed with 'alpha'.
• yarn release --release-as patch to force bump the patch number in the version tag.
• yarn release --release-as minor to force bump the minor number in the version tag.
• yarn release --release-as major to force bump the major number in the version tag.

Community

What's Cozy?

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.

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 to 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 maintainer for LyonLivingLabEnergy is hsubtil, send him/her a 🍻 to say hello!

Get in touch

You can reach the Cozy Community by:

• Chatting with us on IRC #cozycloud on Freenode
• Posting on our Forum
• Posting issues on the Github repos
• Say Hi! on Twitter

License

LyonLivingLabEnergy is developed by "La métropole de Lyon" and distributed under the AGPL v3 license.