Merge pull request #173 from mapswipe/dev

Switch Master to v2

Author: Hagellach37

.gitignore

@@ -110,19 +110,17 @@ ENV/
 .envrc
 *.pickle
 .idea
-import_module/data
 
-# don't upload config files and api keys etc.
-cfg/config.cfg
-cfg/configuration.json
-mapswipe_workers/configuration.json
-cfg/serviceAccountKey.json
-cfg/msf-mapswipe_serviceAccountKey.json
-cfg/dev-mapswipe_serviceAccountKey.json
-cfg/test-mapswipe_serviceAccountKey.json
+# serviceAccountKey for Google Platform access
+*serviceAccountKey.json
+
+# don't upload config files and api keys etc. for python_workers
+mapswipe_workers/config/configuration.json
 
 # don´t upload data dir
 data/
 
+# don't upload app config for project managers dashboard
+app.js
 
 .DS_Store

.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/source/requirements.txt

README.md

@@ -1,31 +1,39 @@
-# Python MapSwipe Workers Documentation
-[MapSwipe](http://mapswipe.org/) is a mobile app that lets you search satellite imagery to help put the world's most vulnerable people on the map. This repository handles everything related to the backend processing of the app. If you are new to MapSwipe it might be good to have a look at the [FAQs](http://mapswipe.org/faq.html) first.
+# MapSwipe Back-End
 
-## Getting Started
-The python-mapswipe-workers consist of several python scripts. They do the following things:
-* **import**: create new projects for the MapSwipe app, which have been uploaded by project managers from humanitarian organizations
-* **transfer results**: make sure that the produced results are stored in a data base
-* **update**: generate up-to-date statistics in the app, e.g. progress and number of contributors per project
-* **export**: provide access to MapSwipe data in json-format
+[MapSwipe](http://mapswipe.org/) 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](http://mapswipe.org/faq.html) first.
 
-We created a documentation for this project at [Read the Docs](https://mapswipe-workers.readthedocs.io/en/master/).
+The MapSwipe Back-End consists of a number of components:
 
-## Project Types
-The MapSwipe backend workers currently support the following project types:
+1. Firebase Project
+2. MapSwipe Workers
+4. Postgres Database
+3. Manager Dashboard
+5. API
+
+Please refer to the documentation for more information: https://mapswipe-workers.readthedocs.io/en/
+
+
+## Ressources
+
+- GitHub repository of the MapSwipe Back-End: https://github.com/mapswipe/python-mapswipe-workers
+- GitHub repository of the MapSwipe Website: https://github.com/mapswipe/mapswipe.github.io
+- GitHub repository of the MapSwipe App https://github.com/mapswipe/mapswipe
+- Website of MapSwipe: https://mapswipe.org
+- OSM-Wiki page of MapSwipe: https://wiki.openstreetmap.org/wiki/MapSwipe
 
-| Name | ID | Description | Screenshot |
-| ---- | -- | ----------- | ---------- |
-| BuildArea | 1 | A 6 squares layout is used for this project type. By tapping you can classify a tile of satellite imagery as *yes*, *maybe* or *bad_imagery*. Project managers can define which objects to look for, e.g. "buildings". Furthermore, they can specify the tile server of the background satellite imagery, e.g. "bing" or a custom tileserver. | <img src="docs/_static/img/BuildArea_screenshot.png" width="250px"> |
 
 ## License
+
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details
 
 ## Authors
+
 * **Benjamin Herfort** - HeiGIT - [Hagellach37](https://github.com/Hagellach37)
 * **Marcel Reinmuth** - HeiGIT - [maze2point0](https://github.com/maze2point0)
 * **Matthias Schaub** - HeiGIT - [Matthias-Schaub](https://github.com/Matthias-Schaub)
 
 See also the list of [contributors](contributors.md) who participated in this project.
 
 ## Acknowledgements
+
 * Humanitarian organizations can't help people if they can't find them.

api/Dockerfile

@@ -0,0 +1,3 @@
+FROM nginx:stable
+COPY nginx.conf /etc/nginx/conf.d/
+COPY index.html /usr/share/nginx/html/api/

docker/index.html api/index.htmldocker/index.html renamed to api/index.html

@@ -0,0 +1,9 @@
+server {
+    listen 80;
+    server_name api;
+
+    location / {
+        alias /usr/share/nginx/html/api/;
+        autoindex on;
+    }
+}

api/nginx.conf

@@ -1,13 +1,16 @@
-# Python MapSwipe Workers contributors (sorted alphabetically)
+# MapSwipe Workers contributors (sorted alphabetically)
 
 * [Benjamin Herfort](https://github.com/Hagellach37):
-    * Author and maintainer
-    * most features development
+    * author and maintainer
+    * development of most of the features
 
 * [Marcel Reinmuth](https://github.com/maze2point0):
     * server setup
     * data base setup and processing
 
 * [Matthias Schaub](https://github.com/Matthias-Schaub)
-    * documentation and readthedocs
-    * testing
+    * documentation
+    * testing
+    * project structure
+    * server setup
+

cfg/your_config_file.json

@@ -0,0 +1,6 @@
+git pull
+python3 test_config.py
+sudo docker-compose build --no-cache
+sudo docker-compose up -d --force-recreate
+sudo docker logs firebase_deploy
+sudo docker ps -a