Add some more instructions to the README.
This commit is contained in:
parent
f8eec7299b
commit
bb9c2b2366
51
README.md
51
README.md
@ -1,14 +1,57 @@
|
|||||||
# ojuso-map
|
|
||||||
[![Translation](http://translate.ojuso.org/widgets/platform/-/svg-badge.svg)](http://translate.ojuso.org/engage/platform/?utm_source=widget)
|
[![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
|
Kickass map for the Ojuso Project
|
||||||
|
|
||||||
# Run The Tests
|
# Getting Started
|
||||||
|
|
||||||
|
## Install System Dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ cat system-requirements.txt | sudo apt-get install -y
|
$ cat system-requirements.txt | sudo apt-get install -y
|
||||||
$ pip install -r test_requirements.txt
|
|
||||||
$ pytest
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Please note, the system dependencies have only been tested on Debian Stretch.
|
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
|
||||||
|
|
||||||
|
```
|
||||||
|
$ django-admin.py migrate
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run The Tests
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
$ pip install -r test_requirements.txt
|
||||||
|
$ pytest -v
|
||||||
|
```
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
libgdal-dev
|
libgdal-dev
|
||||||
python3-gdal
|
python3-gdal
|
||||||
gdal-bin
|
gdal-bin
|
||||||
|
postgresql
|
||||||
|
Loading…
Reference in New Issue
Block a user