Track and share issues (work, interruption in routes, parked cars) in realtime on bike lanes! https://cyclo.phyks.me/
Phyks (Lucas Verney) 2e4e2c50e8 Update MapTiler URL 3 weeks ago
build Create a sprite for the report icons, to ensure they are all loaded at the same time 4 months ago
config Upgrade to Webpack 4 + improve the build system 8 months ago
doc Handle value conversion in filtering API 6 months ago
po Use Zanata to handle translations 9 months ago
scripts Add extra checks for OpenData works importer 2 months ago
server Add a default value for source in Report model 4 months ago
src Update MapTiler URL 3 weeks ago
static Fix OpenGraph icon, OG does not support SVG 9 months ago
support Add a service worker and cache assets 6 months ago
tests Move map from Leaflet to OpenLayers 8 months ago
.babelrc Add unittests for dates tools 4 months ago
.editorconfig Display reports on the map 10 months ago
.eslintignore Add proper unittests 4 months ago
.eslintrc.js Bump dependencies 5 months ago
.gitignore Move map from Leaflet to OpenLayers 8 months ago
.gitlab-ci.yml Set up Gitlab CI 4 months ago
.po2json.sh Use Zanata to handle translations 9 months ago
CODE_OF_CONDUCT.md Review contributing/code of conduct/readme doc 7 months ago
CONTRIBUTING.md Add proper unittests 4 months ago
LICENSE.md Add some doc 10 months ago
README.md Improve OpenData handling for roadwork, clear mention in About section and add OpenData for Loiret 6 months ago
humans.txt Use font-display CSS property and add OpenGraph meta tags 9 months ago
index.html Rename Cyclassist to Cygnal 3 months ago
package.json Fix a bug in NoSleep 0.9.0 and Firefox for Android, https://github.com/richtr/NoSleep.js/issues/63 3 months ago
requirements.txt Initial commit 10 months ago
robots.txt Add robots.txt and humans.txt files 9 months ago
wsgi.py Add a WSGI file 10 months ago
yarn.lock Fix a bug in NoSleep 0.9.0 and Firefox for Android, https://github.com/richtr/NoSleep.js/issues/63 3 months ago
zanata.xml Use Zanata to handle translations 9 months ago

README.md

Cyclassist

Track and share issues (work, interruption in routes, parked cars) in realtime on bike lanes!

This app is made of two parts: a client webapp and a server part to store and serve the issues. This code is the code running behind https://cyclo.phyks.me/ (the stable and official instance).

A sandbox instance if you want to try it out without polluting the main instance is available at https://cyclo-dev.phyks.me. Please note however this is a development instance which might be ahead of the official https://cyclo.phyks.me instance from time to time. It might break from time to time.

As of current version, only the client side part (code running on your local device) handles your geolocation. Your precise geolocation is never sent to the server or any external resource. However, the map background is downloaded on demand from Thunderforest so they could know the location of the displayed map.

OpenData

The data collected by https://cyclo.phyks.me/ is available under an ODbL license. You can get the most up to date JSON dump of available reports at https://cyclo.phyks.me/api/v1/reports.

Statistics about the instance can be fetched at https://cyclo.phyks.me/api/v1/stats.

Documentation

Detailed documentation about this software is available under the doc/ folder. This covers setting up your own instance, API, privacy choices etc.

Contributing

Check out the CONTRIBUTING.md file for all the required doc and details before contributing :) Any contributions are more than welcome!

License

This software is licensed under an MIT license, unless explicitly mentionned otherwise.

Icons are made from the original works:

Beep sound is provided under CC0 license and coming from freesound.org.

The map background is using tiles from Carto.com or Thunderforest, thanks to OpenStreetMap contributors and Leaflet.

Manual location picking uses the awesome API from adresse.data.gouv.fr.

Details about the sources and licenses of the opendata imported is available in the scripts/opendata/ scripts.

Thanks

Thanks a lot to all users, contributors and translators for the help on this software.

Among others, thanks to

  • Quenti for the Occitan translation.