GMBA Connect

A search engine and members directory for the Global Mountain Biodiversity Assessment (GMBA) research network.

Installation

Get a hold of Python 3 and Pipenv on your machine.

$ git clone https://gitlab.com/datalets/gmba-connect.git

To install and start the backend using Pipenv (Pip and Virtualenv should work fine too):

$ pipenv --three
$ pipenv install

To create a blank database or upgrade the configured one:

$ flask db upgrade

To initialize and/or migrate the database, if necessary:

$ flask db init
$ flask db migrate

To start the backend:

$ FLASK_ENV="dev" FLASK_DEBUG=1 python run.py

The app will now be available, and you can access the backend administration at http://0.0.0.0:5000/admin/

Administration

In the backend you can manage all the data, as well as importing data exports in CSV format which are uploaded in the data subfolder.

Check the log for the port and URL to the admin interface, which will by default in production be randomly generated on every app start. You can override this by setting the ADMIN_PATH environment variable.

To update the mountain shapes, replace the geodata/gmba.geojson file.

Note: for development purposes an offline.html file loads un-minified JavaScript packages from the local server, not CDNs. To use this, first install the packages using yarn from the root folder.

Deployment

Use a WSGI server like Gunicorn to host the app in production mode, e.g.:

gunicorn app:app

The Procfile in this project folder makes it ready for deployment to Heroku.

We suggest using supervisor to run the project with a configuration as follows:

[program:gmba]
user=gmbauser
stdout_logfile=/opt/gmba-connect/stdout.log
stderr_logfile=/opt/gmba-connect/stderr.log
directory=/opt/gmba-connect

environment=
        HOME="/home/gmbauser",
        FLASK_APP="app.py",
        FLASK_CONFIG="production",
        SECRET_KEY="abCd3f...",
        SERVER_URL="https://...",
        DATABASE_URL="postgres://...",
        ADMIN_PATH="my-admin-path",
        TIME_ZONE="Europe/Zurich"

command=/home/gmbauser/.local/bin/pipenv run gunicorn --timeout 300 -w 4 -b 127.0.0.1:5141 app:app

Based on the above you can add an nginx proxy to port 5141.

License

MIT - details in LICENSE file.