README.md

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