instructions.md

Get started to contribute to Greentastic

For full functionality (including own deployment) you need:

• XCode>=10
• Python>=3.6
  • numpy
  • googlemaps
  • polyline
  • flask
  • gunicorn
• Billed account on Google Cloud Platform (get started here)
  • API Dependencies (need to be enabled individually)
    • Directions
    • Places
  • Google Cloud SDK (get started here)
  • Paste your keypair into the repo's main folder and name it greentastic.keypair

Test backend functionality:

Create a virtual environment:

python3 -m venv env

Activate the environment:

source env/bin/activate

Install in editable mode for development:

pip install  -r requirements.txt

Run

python app.py

the output roots to

http://localhost:5000/

and you can query directions e.g. from Ütliberg to Zürichberg by:

http://localhost:5000/query_directions?source=Uetliberg&destination=Zuerichberg

or run it from command line by:

curl -X GET "http://localhost:5000/query_directions?weights=1,1,1,1,1&source=Uetliberg&destination=Zuerichberg"

you can also make a POST request via curl and point to a json with a user profile:

curl "http://localhost:5000/query_directions?source=Uetliberg&destination=Zuerichberg" -d '@user_profile.json'

Deploy the backend as API:

Make sure to enable the Google Cloud Platform dependencies and add the keypair, then deploy (takes several minutes):

gcloud app deploy

and then run

gcloud app browse

Currently, you can access the API on https://clean-commuter.appspot.com/ (the root doesn't work, you have to enter a query as shown above).