Code Directory Tree Structure

This page describes the structure of the code comprising the project.

Python

All Python modules reside in the root directory of the repository:

main.py: main server code, using the Flask web framework.
models.py: definitions for the classes used in the Python code, and through SQLAlchemy, definitions for the corresponding database tables.
process.py: loading data from the Central Bureau of Statistics (LMS), of which a sample resides in static/data/lms.
united.py: loading data from United Hatzala, of which a sample resides in static/data/united.
importmail.py: connecting to the Gmail inbox we use for storing the United Hatzala data; used by united.py.
clusters_calculator.py, globalmaptiles.py: algorithm for calculating clusters of markers to be sent instead of individual ones in far zoom level.
localization.py: translation of field values.
field_names.py: English names of fields from LMS data.
constants.py: default values for map parameters.
base.py, config.py, database.py: configuration for database and web access.
oauth.py: user authentication.
utilities.py: miscellaneous utilities.
save_discussions.py, load_discussions.py: used for saving/loading discussion markers to/from Disqus.

We use Jinja2 for templates, to allow embedding data into HTML files. All templates reside in templates.

index.html: template for main page, containing the map and mostly everything else too. The rest of the templates are used for administration purposes.

All Javascript code resides in static/js.

app.js: main client-side code, defining the Backbone models and creating the Google Map.
sidebar.js: creates and handles the sidebar filters menu and list of displayed markers.
marker.js: handles individual markers and the info window that pops when clicked.
localization.js, constants.js: contain the same information as in the similarly named Python modules.
inv_dict.js, veh_dict.js: strings used for displaying involved/vehicle information.
tour.js: "getting started" tour that pops on the first use of the app.

All CSS stylesheets reside in static/css.