From 42de95b37a622ab52e605f8be7880fc150c68b4f Mon Sep 17 00:00:00 2001 From: build-pipeline <build-token> Date: Wed, 5 Apr 2023 07:24:17 +0000 Subject: [PATCH] publish: Merge branch 'update-readme' into 'dev' generated from commit 87abe715933348cf6488b3d5b96d44444fcf15c4 --- README.md | 87 +++++++++++++++++++++++-------------------------------- 1 file changed, 37 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 801cb647f..d7c001cc9 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,32 @@ ## 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. +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. -## Hack +## How does it works ? -_:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package management. Don't hesitate to [install][yarn-install] and use it for your Cozy projects, it's now our main node packages tool for Cozy official apps. +Ecolyo uses "konnectors" for fetching data. More on : -### Install +- [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) +- [egl konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/egl-konnector) -Hacking the Cozy Ecolyo app requires you to [setup a dev environment][setup]. +## Development + +For a more complete look at our project, check our [Self Data Docs](https://doc.self-data.alpha.grandlyon.com/) + +_: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/). 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 install +git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo.git +cd ecolyo +yarn ``` -:pushpin: 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 @@ -30,18 +35,17 @@ Cozy's apps use a standard set of _npm scripts_ to run common tasks, like watch, First of all get cozy dev image : ```sh -$ docker pull cozy/cozy-app-dev +docker pull cozy/cozy-app-dev ``` Then you can run your application inside a Cozy thanks to the [cozy-stack docker image][cozy-stack-docker]: ```sh # 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. +After the build and the stack launched, your app is now available at <http://ecolyo.cozy.tools:8080>. ### Run it inside custom Docker @@ -52,13 +56,20 @@ For the project we have created our own docker container. For more information o Tests are run by [jest] under the hood. You can easily run the tests suite with: ```sh -$ cd ecolyo -$ yarn test +yarn test ``` :pushpin: Don't forget to update / create new tests when you contribute to code to keep the app the consistent. -## Models +### Open a Pull-Request + +If you want to work on Ecolyo and submit code modifications, feel free to open pull-requests! See the [contributing guide][contribute] for more information about how to properly open pull-requests. + +### Commits + +You must follow these rules to write your commit messages : [Conventional Commits Specification][conventional-commits] + +### Data storage 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. @@ -69,27 +80,19 @@ 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`][doctypes]. 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`][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`][konnector-doctype] in [Konnectors]. -### Open a Pull-Request - -If you want to work on Ecolyo and submit code modifications, feel free to open pull-requests! See the [contributing guide][contribute] for more information about how to properly open pull-requests. - -### Commits - -You must follow these rules to write your commit messages : [Conventional Commits Specification][conventional-commits] - ## Community -### What's Cozy? - -<div align="center"> - <a href="https://cozy.io"> - <img src="https://cdn.rawgit.com/cozy/cozy-site/master/src/images/cozy-logo-name-horizontal-blue.svg" alt="cozy" height="48" /> - </a> - </div> - </br> +### 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. +You can reach the Cozy Community by: + +- Chatting with us on IRC [#cozycloud on Freenode][freenode] +- Posting on our [Forum][forum] +- Posting issues on the [Github repos][github] +- Say Hi! on [Twitter][twitter] + ### Localization Localization and translations are handled by [Transifex][tx], which is used by all Cozy's apps. @@ -100,29 +103,15 @@ As a _developer_, you must [configure the transifex client][tx-client], and clai ### Maintainer -The lead maintainer for Ecolyo is [hsubtil](https://forge.grandlyon.com/ext.sopra.husubtil), send him/her a :beers: to say hello! - -### Get in touch - -You can reach the Cozy Community by: - -- Chatting with us on IRC [#cozycloud on Freenode][freenode] -- Posting on our [Forum][forum] -- Posting issues on the [Github repos][github] -- Say Hi! on [Twitter][twitter] +Ecolyo is maintained by the [factory team](https://forge.grandlyon.com/groups/web-et-numerique/factory/-/group_members) feel free to get in touch ! ## License Ecolyo is developed by "La métropole de Lyon" and distributed under the [AGPL v3 license][agpl-3.0]. [conventional-commits]: https://conventionalcommits.org -[standard-version]: https://github.com/conventional-changelog/standard-version [cozy]: https://cozy.io 'Cozy Cloud' -[setup]: https://dev.cozy.io/#set-up-the-development-environment 'Cozy dev docs: Set up the Development Environment' [yarn]: https://yarnpkg.com/ -[yarn-install]: https://yarnpkg.com/en/docs/install -[cozy-ui]: https://github.com/cozy/cozy-ui -[cozy-client-js]: https://github.com/cozy/cozy-client-js/ [cozy-stack-docker]: https://github.com/cozy/cozy-stack/blob/master/docs/client-app-dev.md#with-docker [doctypes]: https://cozy.github.io/cozy-doctypes/ [bill-doctype]: https://github.com/cozy/cozy-konnector-libs/blob/master/models/bill.js @@ -138,6 +127,4 @@ Ecolyo is developed by "La métropole de Lyon" and distributed under the [AGPL v [forum]: https://forum.cozy.io/ [github]: https://github.com/cozy/ [twitter]: https://twitter.com/cozycloud -[nvm]: https://github.com/creationix/nvm -[ndenv]: https://github.com/riywo/ndenv [jest]: https://facebook.github.io/jest/ -- GitLab