README.md

plant.mi

A prototype for a citizen participation application created over the course of a hackathon at University of Vienna.

Run instructions

Create a Python venv

$ python -m venv .venv/

Activate the venv

Depends on the OS. Please check the python documentation: https://docs.python.org/3/library/venv.html

Install stuff

(venv) $ pip install pipenv
(venv) $ pipenv install

should install all the stuff you need.

Run

$ flask run

Should be enough to run the project from the app/ module.

Contributing

Please use the provided pre-commit-hooks.

This can be done by installing pre-commit with pip or in the pipenv:

$ pipenv install pre-commit

Then installing it into the git hooks:

$ pre-commit install

On each commit, the hooks are run and reformat/clean up/... your code for consistency.