Newer
Older
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
_: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.
### Install
Hacking the Cozy LyonLivingLabEnergy app requires you to [setup a dev environment][setup].
You can then clone the app repository and install dependencies:
```sh
$ git clone https://forge.grandlyon.com/web-et-numerique/llle_project/ecolyo.git
$ cd ecolyo
$ yarn install
```
: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
First of all get cozy dev image :
```sh
$ 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
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:
```sh
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
$ 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.
Cozy ships a [built-in list of `doctypes`][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`][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 LyonLivingLabEnergy 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 and releases
This app uses the [standard-version module][standard-version] to release version automatically.
You must follow these rules to write your commit messages : [Conventional Commits Specification][conventional-commits]
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?
<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>
[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][tx], which is used by all Cozy's apps.
As a _translator_, you can login to [Transifex][tx-signin] (using your Github account) and claim an access to the [app repository][tx-app]. Locales are pulled when app is build before publishing.
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 LyonLivingLabEnergy 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]
## License
LyonLivingLabEnergy 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
[konnector-doctype]: https://github.com/cozy/cozy-konnector-libs/blob/master/models/base_model.js
[konnectors]: https://github.com/cozy/cozy-konnector-libs
[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.html
[contribute]: CONTRIBUTING.md
[tx]: https://www.transifex.com/cozy/
[tx-signin]: https://www.transifex.com/signin/
[tx-app]: https://www.transifex.com/cozy/<SLUG_TX>/dashboard/
[tx-client]: http://docs.transifex.com/client/
[freenode]: http://webchat.freenode.net/?randomnick=1&channels=%23cozycloud&uio=d4
[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/