Skip to content

yonitz/anyway

 
 

Repository files navigation

ANYWAY Build Status Build status

anyway.co.il - Crowd-sourced road hazard reporting website.
Also available at oway.org.il.

Feel free to contribute to the project.

To report bugs and feature requests, please open an issue on GitHub.

See also our Android app and iOS app on GitHub.

The datasets Anyway uses are documented here:

See Code Directory Tree Structure.

About

Anyway's main goal is raising awareness of road accidents and act to avoid them, by showing road accidents with casualties over map.
The shown data based on reports supplied by the Israeli Central Bureau of Statistics (CBS) and real time reports from United Hatzalah of Israel.
Anyway is an open source project, sponsored by The Public Knowledge Workshop (“Hasadna”).

Contributing

  • We try to follow the process of other Hasadna projects, e.g. Open-Knesset.
  • Please take a moment to read our "Contributing to ANYWAY" manifest.
  • To see our GitHub issues in a nicer interface, take a look at HuBoard. Check out the Ready list to find a task to work on. The Backlog list there contains issues that are still not ready to be started. The Working list contains issues already started by developers (make sure to move your issue there once you start working on it), and the Done list contains completed issues that are waiting to be confirmed done and closed.

Getting the code

  1. Fork this repository on GitHub
  2. git clone https://github.com/*you*/anyway
  3. Add the main repository as your upstream remote: git remote add upstream https://github.com/hasadna/anyway
  • Get updates whenever you start working: git pull upstream dev
  • Push to your fork when you've committed your changes and tested them: git push. Now make sure CI tests are passing (Travis CI and AppVeyor) and make a pull request from your fork on GitHub

Docker

We are using DOCKER. See DOCKER

Optional: Getting the Data

  1. Optionally, Get the complete accidents file after sending a permission request, and extract it into /static/data/cbs. Otherwise, you'll use the example accidents files that you already got with the code.
  2. Get the RSA file from rsa file after sending a permission request and extract the file into /static/data/rsa.

Optional: Adding CI to your forked repository

  1. Add Travis CI to your forked repository - in your github forked repository: Settings -> Integrations & services -> Add service -> Travis CI
  2. Add AppVeyor to your forked repository - Login with your GitHub account -> New Project -> GitHub -> anyway

Testing

To run tests: pylint -j $(nproc) anyway tests && pytest -m "not browser" ./tests

If you also wish to run the real browser tests, replace-m "not browser" with --driver Chrome or specify the browser of your choice. To learn more, read about pytest-selenium.

Altering the database schema

When creating a patch that alters the database schema, you should use generate the appropriate Alembic revision by running:

alembic revision --autogenerate -m "Description of the change"

Make sure to commit your revision together with the code.

Translation and Localization

See TRANSLATE

About

ANYWAY - Car accidents map

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 49.8%
  • JavaScript 29.6%
  • CSS 12.9%
  • HTML 7.5%
  • PLpgSQL 0.1%
  • Dockerfile 0.1%