diff --git a/README.md b/README.md index 345e1b2624638e39efab6cac6ce7bd0aec360f48..ca7215d9dba20f54724adf184838ccb4ad1f5cb7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ -# Ecolyo +#  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. - +but give also some tips on how to reduce energy consumption. ## Hack @@ -26,10 +25,10 @@ $ 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 : + ```sh $ docker pull cozy/cozy-app-dev ``` @@ -45,6 +44,7 @@ $ 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 @@ -58,7 +58,6 @@ $ yarn test :pushpin: 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. @@ -70,7 +69,6 @@ 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. @@ -79,7 +77,6 @@ If you want to work on Ecolyo and submit code modifications, feel free to open p You must follow these rules to write your commit messages : [Conventional Commits Specification][conventional-commits] - ## Community ### What's Cozy? @@ -91,7 +88,7 @@ You must follow these rules to write your commit messages : [Conventional Commit </div> </br> -[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. +[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 @@ -101,12 +98,10 @@ As a _translator_, you can login to [Transifex][tx-signin] (using your Github ac As a _developer_, you must [configure the transifex client][tx-client], and claim an access as _maintainer_ to the [app repository][tx-app]. 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 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: @@ -116,17 +111,14 @@ You can reach the Cozy Community by: - Posting issues on the [Github repos][github] - Say Hi! on [Twitter][twitter] - ## 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" +[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