Skip to content

OxfordDemSci/dgg-www

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dgg-www

Digital Gender Gaps Web Application

The Digital Gender Gaps Web Application provides an interactive map to explore national indicators of gender equality in access to the internet and mobile phones and their trends through time. The web application provides intuitive visualisations of spatial data, bulk data downloads, and an API to automate on-the-fly data requests for data scientists and web developers.

Components

  1. Leaflet front-end with interactive map.
  2. Flask API to query data
  3. PostgreSQL database

Docker Deployment

To launch the app using the Docker deployment, you must first install Docker and Docker-Compose. The easiest way to do this may be Docker Desktop. Alternatively, you can install Docker Engine and Docker Compose individually.

The Docker deployment for this application uses three containers that are defined in ./docker-compose.yml:

  1. dgg_web: An nginx web server (see ./www/)
  2. dgg_api: A Flask API running behind a gunicorn WSGI server (see ./api/)
  3. dgg_db: A PostgreSQL database (see ./sql/)

To build and launch the Docker containers from the command line:

cd .../dgg-www
docker-compose up -d --build

You can check the status of active docker containers using:

docker ps
docker stats

While the containers are running, you can view the app from your web browser:

To stop the containers, use:

docker-compose down

Suggested Citation

If possible, please cite a specific release version using the suggested citation in the release documentation which should include a version number and digital object identifier (DOI).

Otherwise, please use the following generic citation:

Leasure DR, Yan J, Bondarenko M, Kerr D, Fatehkia M, Weber I, Kashyap R. 2023. Digital Gender Gaps Web Application. GitHub. https://github.com/OxfordDemSci/dgg-www

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details (see LICENSE file or https://www.gnu.org/licenses/).