• Docker: Installation guide
• Docker-compose: Installation guide
• Pre-commit: Installation guide
• Black: Just run pip install --user black
• git-lfs: https://github.com/git-lfs/git-lfs/wiki/Installation and git lfs install in your repository

If you want a local dev setup:

• python 3.7
• virtualenv or virtualenvwrapper

To setup your local env using virtualenvwrapper

    mkvirtualenv beges --python=3.7
    pip install pre-commit black
    pre-commit install
    pip install -r app/src/requirements.txt

If you want to go source your virtual env:

workon beges

Copy the .env-template file:

cp .env-template .env

Fill the variables in the created .env file:

• DATA_DIR: A path on your host where data will be written
• APP_PORT_PROD: The port you want the app to be exposed in prod setup (default is 5010)
• APP_PORT_DEV: The port you want the app to be exposed in dev setup (default is 5011)
• GMAP_API_KEY: API_KEY needed to geocode places

Build the docker image:

make build

Download and prepare the datasets:

make download-datasets
make prepare-datasets

You can start the local server:

make run-dev-server

If you kept the default APP_PORT_DEV variable, then you have access to the app on localhost:5011.

• build: will build the app image
• run-bash: will run a bash in the app container
• run-prod-server: will run the app using nginx / uwsgi
• run-dev-server: will run the app in debug mode (file watching and automatic restarts)
• download-datasets: will download all the necessary files from the drive or the www (just run the app/src/scripts/download_datasets.sh script)
• prepare-datasets: will prepare the different datasets (just run the app/src/scripts/prepare_datasets.sh script)