Installation Guide#

Development#

There are two supported ways to start the development server:

Start only the auxiliary services (database, redis, etc.) in docker but start the django dev server locally in your virtual env. This is the preferred way if you actively develop this application.
Start everything inside docker containers. This is the “easy” way to start a dev server and fiddle around with it, hot reloading included. But you will not have the local pre-commit setup.

In both cases there are some common steps to follow:

Make sure you have make installed (e.g. with sudo apt install make for Debian based distributions)
Install docker and docker-compose for your system

Clone git repository and checkout branch develop:

git clone https://github.com/base-angewandte/portfolio-backend.git
cd portfolio-backend
git checkout develop

Check and adapt settings (see Configuration for further details about the configuration possibilities):

# env
cp env-skel .env
vi .env

# django env
cp ./src/portfolio/env-skel ./src/portfolio/.env
vi ./src/portfolio/.env

Create docker-compose override file:

cp docker-compose.override.dev.yml docker-compose.override.yml

Now, depending on which path you want to go, take one of the following two subsections.

Everything inside docker#

Make sure that the DOCKER variable in ./src/portfolio/.env is set to TRUE. Otherwise Django will assume that the other services are accessible on localhost ports.

Now create the docker-compose override file:

cp docker-compose.override.dev.docker.yml docker-compose.override.yml

Start everything:
```
make start-dev-docker
```
Alternatively, if make is not installed on your system yet, you can also just use docker-compose directly:
```
docker-compose up -d --build portfolio-redis portfolio-postgres portfolio-lool portfolio-django
```
If you did start the service with the docker-compose instead of make, you might want to do the following to also get Django’s debug output:
```
docker logs -f portfolio-django
```
To stop all services again, use make stop or docker-compose down.

The full developer setup#

Install latest python 3.8 and create a virtualenv e.g. via pyenv and pyenv-virtualenv

Install pip-tools and requirements in your virtualenv:

pip install pip-tools
pip-sync src/requirements-dev.txt

Install pre-commit hooks:
```
pre-commit install
```

Install required packages for media conversion:

Debian based Linux distributions

sudo apt install bc \
  ffmpeg \
  ghostscript \
  imagemagick \
  libmagic-dev \
  webp \
  exiftool

macOS (Installation recommended via homebrew)

brew install ffmpeg ghostscript imagemagick webp exiftool

Start required services:
```
make start-dev
```
Run migration:
```
cd src
python manage.py migrate
```
Start development server:
```
python manage.py runserver 8200
```

Note

If you are working on a system with non-US/UK locales you might use a number format that uses , as decimal separator rather than .. In that case audio and video conversions will fail due to an error when printf is used to format the duration. This should not affect the containerised dev and production setup. To work around this, set the LC_NUMERIC environment variable to en_US.UTF-8, e.g. by starting the dev server with the following command:

LC_NUMERIC="en_US.UTF-8" python manage.py runserver 8200

Production#

Update package index:

# RHEL
sudo yum update

# Debian
sudo apt-get update

Install docker and docker-compose
Create and change to user base
Create and change to /opt/base

Clone git repository and checkout branch main:

git clone https://github.com/base-angewandte/portfolio-backend.git
cd portfolio-backend
git checkout main

Check and adapt settings (see Configuration for further details about the configuration possibilities):

# env
cp env-skel .env
vi .env

# django env
cp ./src/portfolio/env-skel ./src/portfolio/.env
vi ./src/portfolio/.env

Use Makefile to initialize and run project:
```
make start init restart-gunicorn
```
Install nginx and configure it accordingly