ojuso-map/README.md
2018-04-12 21:48:20 +02:00

58 lines
1.3 KiB
Markdown

[![Translation](http://translate.ojuso.org/widgets/platform/-/svg-badge.svg)](http://translate.ojuso.org/engage/platform/?utm_source=widget)
[![pipeline status](https://gitlab.com/autonomic-cooperative/ojuso-map/badges/master/pipeline.svg)](https://gitlab.com/autonomic-cooperative/ojuso-map/commits/master)
[![coverage report](https://gitlab.com/autonomic-cooperative/ojuso-map/badges/master/coverage.svg)](https://gitlab.com/autonomic-cooperative/ojuso-map/commits/master)
# ojuso-map
Kickass map for the Ojuso Project
# Getting Started
## Install System Dependencies
```bash
$ cat system-requirements.txt | sudo apt-get install -y
```
Please note, the system dependencies have only been tested on Debian Stretch.
## Bootstrap the Virtual Environment
Get your Python 3 environment on the go:
```bash
$ python3 -m venv .venv
```
## Configure the Environment
```bash
$ export DEBUG=1
$ export DJANGO_SETTINGS_MODULE=ojusomap.settings
```
## Install the Python Dependencies
```bash
$ pip3 install -r requirements.txt
```
If you run into issues with `psycopg2` you may need to run the following:
```bash
$ pip uninstall psycopg2 && pip install --no-binary :all: psycopg2
```
## Run The Migrations
```
$ python manage.py migrate
```
## Run The Tests
``` bash
$ pip install -r test_requirements.txt
$ pytest -v
```