README.md: add usage instructions

This commit is contained in:
Alan Orth 2021-12-08 20:19:33 +02:00
parent ac2929e3e8
commit 117ee6b698
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9

View File

@ -11,6 +11,19 @@
You can try [the hosted version](https://fierce-ocean-30836.herokuapp.com) or host it yourself (see below). You can try [the hosted version](https://fierce-ocean-30836.herokuapp.com) or host it yourself (see below).
## Usage
Create a Python 3.7+ virtual environment and install the dependencies:
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
## Running Locally
$ gunicorn csv_metadata_quality_web.main
And then visit http://localhost:8000/ in your browser.
## License ## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).