From 9d91fa0b71cfd31a75fba5f391da51cb6b3f7136 Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Fri, 29 Jun 2018 10:51:43 +0200 Subject: [PATCH] Add links to cyclo.phyks.me + clarify how geolocation is handled --- README.md | 30 +++++++++++++++++++++--------- src/components/About.vue | 2 +- src/i18n/en.js | 3 ++- src/i18n/fr.js | 3 ++- 4 files changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a03c569..321131f 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,23 @@ Cyclassist > realtime on bike lanes! This app is made of two parts: a client webapp and a server part to store and -serve the issues. +serve the issues. This code is the code running behind https://cyclo.phyks.me/. -## Client part +As of current version, only the client side part (code running on your local +device) handles your geolocation. **Your geolocation is never sent** to the +server or any external resource. -### Build setup +## OpenData + +The data collected by https://cyclo.phyks.me/ is available under an +[ODbL](https://opendatacommons.org/licenses/odbl/) license. You can get the +most up to date JSON dump of available reports at https://cyclo.phyks.me/api/v1/reports. + +## Hosting your own + +### Client part + +#### Build setup ``` bash # Install JS dependencies @@ -25,7 +37,7 @@ yarn build yarn build --report ``` -### Useful environment variables +#### Useful environment variables You can pass a few environment variables to the `yarn build|dev` commands to adapt the behavior to your needs. @@ -37,9 +49,9 @@ adapt the behavior to your needs. one. -## Server part +### Server part -### Build setup +#### Build setup ``` bash # Install Python dependencies @@ -51,7 +63,7 @@ python -m server It is better to use a dedicated `virtualenv` if you can :) -### Useful environment variables +#### Useful environment variables You can pass a few environment variables to the `python -m server` command to adapt its behavior: @@ -63,12 +75,12 @@ adapt its behavior: `sqlite:///reports.db` which means a SQLite database named `reports.db` in the current working directory). -### Serving in production +#### Serving in production You can use the `wsgi.py` script at the root of the git repository to serve the server side part. -### Useful scripts +#### Useful scripts The `scripts` folder contain some useful scripts: diff --git a/src/components/About.vue b/src/components/About.vue index 61c242c..0ea7249 100644 --- a/src/components/About.vue +++ b/src/components/About.vue @@ -2,7 +2,7 @@ -

{{ $t('about.summary') }}

+

{{ $t('about.summary') }} {{ $t('about.geolocationDescription') }}

{{ $t('about.usage') }}

{{ $t('about.usageDescription') }}

diff --git a/src/i18n/en.js b/src/i18n/en.js index 6a42b54..a8e5ef2 100644 --- a/src/i18n/en.js +++ b/src/i18n/en.js @@ -3,8 +3,9 @@ export default { about: { availableReportsTitle: 'The available reports so far are:', gcumDescription: 'A car poorly parked on a bike lane. Such reports are automatically deleted after one hour, as they are by nature temporary.', + geolocationDescription: 'As of current version, your geolocation is handled within your device and never sent from it to any external service.', interruptDescription: 'An interruption of the bike lane (works, unexpected end of the bike lane, etc.).', - license: 'It is released under an MIT license (source code). The map background is using tiles from OpenCycleMap, thanks to OpenStreetMap contributors and Leaflet.', + license: 'It is released under an MIT license (source code). The map background is using tiles from OpenCycleMap, thanks to OpenStreetMap contributors and Leaflet. Collected reports are available under ODbL license.', potholeDescription: 'A pothole in the ground.', summary: 'This app lets you track and share issues with bike lanes.', usage: 'How to use', diff --git a/src/i18n/fr.js b/src/i18n/fr.js index c3ef233..37a421b 100644 --- a/src/i18n/fr.js +++ b/src/i18n/fr.js @@ -3,8 +3,9 @@ export default { about: { availableReportsTitle: "Les signalements disponibles pour l'instant sont :", gcumDescription: "Une voiture (mal) garée sur la piste cyclable. Ces signalements sont automatiquement supprimés au bout d'une heure car ils sont par essence temporaires.", + geolocationDescription: "Dans la version actuelle, votre position est traitée directement par votre appareil et n'est jamais envoyée à un service externe.", interruptDescription: "Une interruption d'itinéraire cyclable (travaux, arrêt inattendu d'une piste cyclable, etc)", - license: "Le code source est sous licence MIT license (code source). Les tuiles de fond de carte proviennent de chez OpenCycleMap, grace aux contributeurs OpenStreetMap et à Leaflet.", + license: "Le code source est sous licence MIT license (code source). Les tuiles de fond de carte proviennent de chez OpenCycleMap, grace aux contributeurs OpenStreetMap et à Leaflet. Les signalements sont disponibles sous licence ODbL.", potholeDescription: 'Un nid de poule dans la route.', summary: 'Cette application vous permet de signaler et de partager des problèmes avec les itinéraires cyclables.', usage: 'Utilisation',