Skip to content
Snippets Groups Projects
Commit 63d68088 authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

Update README.md

parent fa5d31d9
No related tags found
1 merge request!12413.1 Release
...@@ -4,9 +4,13 @@ ...@@ -4,9 +4,13 @@
Ecolyo is a mobile-first app allowing citizens to visualise easily their energy consumption (electricity, gas, water ...). The app allows data visualisation but give also some tips on how to reduce energy consumption. Ecolyo is a mobile-first app allowing citizens to visualise easily their energy consumption (electricity, gas, water ...). The app allows data visualisation but give also some tips on how to reduce energy consumption.
## Ecolyo au-delà de la Métropole de Lyon
<https://doc-self-data.apps.grandlyon.com/docs/ecolyo/share/>
## How does it works ? ## How does it works ?
Ecolyo uses "konnectors" for fetching data. More on : Ecolyo uses "konnectors" for fetching data. More information on our [konnector documentation](https://doc-self-data.apps.grandlyon.com/docs/konnectors/introduction/). Repositories for our konnectors :
- [enedis konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector) - [enedis konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector)
- [grdf konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector) - [grdf konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector)
...@@ -14,21 +18,11 @@ Ecolyo uses "konnectors" for fetching data. More on : ...@@ -14,21 +18,11 @@ Ecolyo uses "konnectors" for fetching data. More on :
## Development ## Development
For a more complete look at our project, check our [Self Data Docs](https://doc-self-data.apps.grandlyon.com/) For a more complete look at our project and our installation guide, check our **[Self Data Docs](https://doc-self-data.apps.grandlyon.com/)**
_:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package management. _:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package management.
Developing the Cozy Ecolyo app requires you to be familiar with [cozy's documentation](https://docs.cozy.io/en/). Developing the Cozy Ecolyo app requires you to be familiar with [cozy's documentation](https://docs.cozy.io/en/). Cozy's apps use a standard set of _scripts_ to run common tasks, like watch, lint, test, build…
You can then clone the app repository and install dependencies:
```sh
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo.git
cd ecolyo
yarn
```
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 ### Run it inside a default Cozy using Docker
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment