phyks/cygnal
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
179 Commits 2 Branches 0 Tags 6 MiB
JavaScript 36.6%
Vue 35.9%
Python 24%
HTML 2%
CSS 1.5%
903ad14bbc
Go to file
Phyks (Lucas Verney) 903ad14bbc Add a service worker and cache assets 
Assets are served from the local cache preferably. They are fetched from
the network if not available. This new addition also enables the "Add to
homescreen" in Chrome/Chromium.

Fix #22.
2018-10-26 14:15:56 +02:00
build Add a service worker and cache assets 2018-10-26 14:15:56 +02:00
config Upgrade to Webpack 4 + improve the build system 2018-08-06 23:29:17 +02:00
doc Handle value conversion in filtering API 2018-10-18 09:39:53 +02:00
po Use Zanata to handle translations 2018-07-20 15:15:26 +02:00
scripts Bump version in constants.js 2018-10-25 11:13:35 +02:00
server Handle value conversion in filtering API 2018-10-18 09:39:53 +02:00
src Add a service worker and cache assets 2018-10-26 14:15:56 +02:00
static Fix OpenGraph icon, OG does not support SVG 2018-07-11 16:54:02 +02:00
support Add a service worker and cache assets 2018-10-26 14:15:56 +02:00
tests Move map from Leaflet to OpenLayers 2018-08-26 17:48:03 +02:00
.babelrc Drop useless Babel plugins 2018-09-04 14:38:32 +02:00
.editorconfig Display reports on the map 2018-06-26 11:04:23 +02:00
.eslintignore Initial commit 2018-06-25 18:29:57 +02:00
.eslintrc.js Add a service worker and cache assets 2018-10-26 14:15:56 +02:00
.gitignore Move map from Leaflet to OpenLayers 2018-08-26 17:48:03 +02:00
.po2json.sh Use Zanata to handle translations 2018-07-20 15:15:26 +02:00
CODE_OF_CONDUCT.md Review contributing/code of conduct/readme doc 2018-09-14 15:56:23 +02:00
CONTRIBUTING.md Improve documentation. Fix #45. 2018-10-17 15:51:06 +02:00
humans.txt Use font-display CSS property and add OpenGraph meta tags 2018-07-11 01:51:26 +02:00
index.html Display an error message when JS is disabled. 2018-07-11 20:34:46 +02:00
LICENSE.md Add some doc 2018-06-26 15:36:45 +02:00
package.json Add a service worker and cache assets 2018-10-26 14:15:56 +02:00
README.md Improve OpenData handling for roadwork, clear mention in About section and add OpenData for Loiret 2018-10-18 15:03:33 +02:00
requirements.txt Initial commit 2018-06-25 18:29:57 +02:00
robots.txt Add robots.txt and humans.txt files 2018-07-10 19:23:32 +02:00
wsgi.py Add a WSGI file 2018-06-26 15:55:52 +02:00
yarn.lock Add a service worker and cache assets 2018-10-26 14:15:56 +02:00
zanata.xml Use Zanata to handle translations 2018-07-20 15:15:26 +02:00

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.