Go to file
2018-06-28 22:56:59 +02:00
build Add a webmanifest 2018-06-28 11:55:11 +02:00
config Add customizable tile server 2018-06-26 16:03:14 +02:00
scripts Add a script to purge old GCUM reports 2018-06-28 15:58:36 +02:00
server Fix an issue with MySQL dropping connection after some time 2018-06-27 22:11:30 +02:00
src Add link to source code in help 2018-06-28 22:56:59 +02:00
static Add a webmanifest 2018-06-28 11:55:11 +02:00
.babelrc Initial commit 2018-06-25 18:29:57 +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 Initial commit 2018-06-25 18:29:57 +02:00
.gitignore Initial commit 2018-06-25 18:29:57 +02:00
.postcssrc.js Initial commit 2018-06-25 18:29:57 +02:00
index.html Add a webmanifest 2018-06-28 11:55:11 +02:00
LICENSE.md Add some doc 2018-06-26 15:36:45 +02:00
manifest.webmanifest Add a webmanifest 2018-06-28 11:55:11 +02:00
package.json Show the reports as soon as they are added in the db 2018-06-26 11:39:43 +02:00
README.md Add a script to purge old GCUM reports 2018-06-28 15:58:36 +02:00
requirements.txt Initial commit 2018-06-25 18:29:57 +02:00
wsgi.py Add a WSGI file 2018-06-26 15:55:52 +02:00
yarn.lock Show the reports as soon as they are added in the db 2018-06-26 11:39:43 +02:00

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.

Client part

Build setup

# Install JS dependencies
yarn install

# Serve with hot reload at localhost:8080
yarn dev

# Build for production with minification
yarn build

# Build for production and view the bundle analyzer report
yarn build --report

Useful environment variables

You can pass a few environment variables to the yarn build|dev commands to adapt the behavior to your needs.

  • PUBLIC_PATH=https://.../foobar to serve the app from a subdirectory.
  • API_BASE_URL=https://... to specify the location of the server (defaults to /). The value should end with a trailing slash.
  • TILE_SERVER= to pass a specific tile server to use rather than the default one.

Server part

Build setup

# Install Python dependencies
pip install -r requirements.txt

# Start the server
python -m server

It is better to use a dedicated virtualenv if you can :)

Useful environment variables

You can pass a few environment variables to the python -m server command to adapt its behavior:

  • HOST= to specify the host to listen to (defaults to 127.0.0.1 which means localhost only).
  • PORT= to specify the port to listen on (defaults to 8081).
  • DATABASE= to specify a database URL to connect to (defaults to sqlite:///reports.db which means a SQLite database named reports.db in the current working directory).

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

The scripts folder contain some useful scripts:

  • purge_old_gcum.py deletes gcum-type report older than one hour. You should set a crontask to call it regularly.

Contributing

The quickest way to get started is to simply run

API_BASE_URL=http://127.0.0.1:8081/ yarn dev

to spawn the client-side webapp, listening on localhost:8080 and

python -m server

to spawn the server-side part, listening on localhost:8081.

License

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