MapSwipe Back-End¶
MapSwipe is a mobile app that lets you search satellite imagery to help put the world’s most vulnerable people on the map. If you are new to MapSwipe it might be good to have a look at the FAQs first.
The MapSwipe Back-End consists of a number of components:
Firebase Project
MapSwipe Workers
Postgres Database
Manager Dashboard
API
Please refer to the documentation for more information: https://mapswipe-workers.readthedocs.io/
Resources¶
MapSwipe Back-End: https://github.com/mapswipe/python-mapswipe-workers
MapSwipe App https://github.com/mapswipe/mapswipe
MapSwipe Website: https://mapswipe.org
MapSwipe OSM-Wiki: https://wiki.openstreetmap.org/wiki/MapSwipe
Contributing Guidelines¶
Feature Branch¶
To contribute to the MapSwipe back-end please create dedicated feature branches based on the dev branch. After the changes create a Pull Request of the feature branch into the dev branch on GitHub:
git checkout dev
git checkout -b featureA
# Hack away ...
git commit -am 'Describe changes.'
git push -u origin featureA
# Create a Pull Request from feature branch into the dev branch on GitHub.
Note: If a bug in production (master branch) needs fixing before a new versions of MapSwipe Workers gets released (merging dev into master branch), a hotfix branch should be created. In the hotfix branch the bug should be fixed and then merged with the master branch (and also dev).
Style Guide¶
This project uses black and flake8 to achieve a unified style.
Use pre-commit to run black and flake8 prior to any git commit. pre-commit, black and flake8 should already be installed in your virtual environment since they are listed in requirements.txt. To setup pre-commit simply run:
pre-commit install
From now on black and flake8 should run automatically whenever git commit is executed.
License¶
This project is licensed under the Apache License 2.0 - see the LICENSE file for details
Acknowledgements¶
Humanitarian organizations can’t help people if they can’t find them.