Add links to cyclo.phyks.me + clarify how geolocation is handled

This commit is contained in:
Lucas Verney 2018-06-29 10:51:43 +02:00
parent 302413598b
commit 9d91fa0b71
4 changed files with 26 additions and 12 deletions

View File

@ -5,11 +5,23 @@ Cyclassist
> realtime on bike lanes! > realtime on bike lanes!
This app is made of two parts: a client webapp and a server part to store and 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 ``` bash
# Install JS dependencies # Install JS dependencies
@ -25,7 +37,7 @@ yarn build
yarn build --report yarn build --report
``` ```
### Useful environment variables #### Useful environment variables
You can pass a few environment variables to the `yarn build|dev` commands to You can pass a few environment variables to the `yarn build|dev` commands to
adapt the behavior to your needs. adapt the behavior to your needs.
@ -37,9 +49,9 @@ adapt the behavior to your needs.
one. one.
## Server part ### Server part
### Build setup #### Build setup
``` bash ``` bash
# Install Python dependencies # Install Python dependencies
@ -51,7 +63,7 @@ python -m server
It is better to use a dedicated `virtualenv` if you can :) 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 You can pass a few environment variables to the `python -m server` command to
adapt its behavior: adapt its behavior:
@ -63,12 +75,12 @@ adapt its behavior:
`sqlite:///reports.db` which means a SQLite database named `reports.db` in `sqlite:///reports.db` which means a SQLite database named `reports.db` in
the current working directory). 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 You can use the `wsgi.py` script at the root of the git repository to serve
the server side part. the server side part.
### Useful scripts #### Useful scripts
The `scripts` folder contain some useful scripts: The `scripts` folder contain some useful scripts:

View File

@ -2,7 +2,7 @@
<v-container fluid> <v-container fluid>
<v-layout row> <v-layout row>
<v-flex xs12 sm6 offset-sm3> <v-flex xs12 sm6 offset-sm3>
<p>{{ $t('about.summary') }}</p> <p>{{ $t('about.summary') }} {{ $t('about.geolocationDescription') }}</p>
<h2 class="body-2">{{ $t('about.usage') }}</h2> <h2 class="body-2">{{ $t('about.usage') }}</h2>
<p>{{ $t('about.usageDescription') }}</p> <p>{{ $t('about.usageDescription') }}</p>

View File

@ -3,8 +3,9 @@ export default {
about: { about: {
availableReportsTitle: 'The available reports so far are:', 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.', 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.).', interruptDescription: 'An interruption of the bike lane (works, unexpected end of the bike lane, etc.).',
license: 'It is released under an <a href="https://opensource.org/licenses/MIT">MIT license</a> (<a href="https://framagit.org/phyks/cyclassist">source code</a>). The map background is using tiles from <a href="https://www.opencyclemap.org/docs/">OpenCycleMap</a>, thanks to <a href="https://www.openstreetmap.org/copyright">OpenStreetMap contributors</a> and <a href="http://leafletjs.com/">Leaflet</a>.', license: 'It is released under an <a href="https://opensource.org/licenses/MIT">MIT license</a> (<a href="https://framagit.org/phyks/cyclassist">source code</a>). The map background is using tiles from <a href="https://www.opencyclemap.org/docs/">OpenCycleMap</a>, thanks to <a href="https://www.openstreetmap.org/copyright">OpenStreetMap contributors</a> and <a href="http://leafletjs.com/">Leaflet</a>. Collected reports are available under <a href="https://opendatacommons.org/licenses/odbl/">ODbL license</a>.',
potholeDescription: 'A pothole in the ground.', potholeDescription: 'A pothole in the ground.',
summary: 'This app lets you track and share issues with bike lanes.', summary: 'This app lets you track and share issues with bike lanes.',
usage: 'How to use', usage: 'How to use',

View File

@ -3,8 +3,9 @@ export default {
about: { about: {
availableReportsTitle: "Les signalements disponibles pour l'instant sont :", 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.", 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)", interruptDescription: "Une interruption d'itinéraire cyclable (travaux, arrêt inattendu d'une piste cyclable, etc)",
license: "Le code source est sous <a href='https://opensource.org/licenses/MIT'>licence MIT license</a> (<a href='https://framagit.org/phyks/cyclassist'>code source</a>). Les tuiles de fond de carte proviennent de chez <a href='https://www.opencyclemap.org/docs/'>OpenCycleMap</a>, grace aux <a href='https://www.openstreetmap.org/copyright'>contributeurs OpenStreetMap</a> et à <a href='http://leafletjs.com/'>Leaflet</a>.", license: "Le code source est sous <a href='https://opensource.org/licenses/MIT'>licence MIT license</a> (<a href='https://framagit.org/phyks/cyclassist'>code source</a>). Les tuiles de fond de carte proviennent de chez <a href='https://www.opencyclemap.org/docs/'>OpenCycleMap</a>, grace aux <a href='https://www.openstreetmap.org/copyright'>contributeurs OpenStreetMap</a> et à <a href='http://leafletjs.com/'>Leaflet</a>. Les signalements sont disponibles sous <a href='https://opendatacommons.org/licenses/odbl/'>licence ODbL</a>.",
potholeDescription: 'Un nid de poule dans la route.', 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.', summary: 'Cette application vous permet de signaler et de partager des problèmes avec les itinéraires cyclables.',
usage: 'Utilisation', usage: 'Utilisation',