ojuso-map/README.md
2018-09-05 11:35:07 -04:00

2.6 KiB

Translation pipeline status coverage report

ojuso-map

Kickass map for the Ojuso Project

Getting Started

Check out the code

$ git clone git@gitlab.com:autonomic-cooperative/ojuso-map.git
$ cd ojuso-map

All commands from here on should be run in the ojuso-map directory.

Install System Dependencies

Debian / Ubuntu

$ xargs < system-requirements-debian.txt sudo apt-get install -y

Fedora

$ xargs < system-requirements-fedora.txt sudo dnf install

If you hadn't previously installed Postgres, you will need to initialise the database and start the server:

$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl start postgresql

Bootstrap the Virtual Environment

Set up your Python virtual environment in the .venv folder:

$ python3 -m venv .venv
$ source .venv/bin/activate

Configure the Environment

$ export DEBUG=1
$ export DJANGO_SETTINGS_MODULE=ojusomap.settings

Install the Python Dependencies

$ pip3 install --upgrade pip setuptools
$ pip3 install -r requirements-devel.txt

If you run into issues with psycopg2 you may need to run the following:

$ pip3 uninstall psycopg2 && pip3 install --no-binary :all: psycopg2

Ensure Postgres is running and accessible

You should be able to connect to Postgres:

$ psql -U postgres -h localhost

(enter "postgres" as the password)

If not, follow these instructions to change the Postgres authentication options (NB on Fedora / Centos, pg_hba.conf is located in /var/lib/pgsql/data), then run:

$ echo "ALTER USER postgres WITH PASSWORD 'postgres';" | psql -U postgres

Run The Migrations

$ python manage.py migrate

Start the server

$ python manage.py runserver

Resuming work

For each new terminal session, you will need to run:

$ cd ojuso-map
$ source .venv/bin/activate
$ export DEBUG=1
$ export DJANGO_SETTINGS_MODULE=ojusomap.settings
$ python manage.py runserver

Running The Tests

$ pip install -r requirements-test.txt
$ pytest -v