Doppeldenk

Spacetrading is a boardgame under development from the designers of EuroCrisis (Doppeldenk Spiele). This repository contains a web application that enables us to test the game online and generate printing material for a prototype to test it offline.

Deployed

On heroku.

Getting started

Follow the MDN Django Tutorial on setting up Django and preparing it for Heroku:

# Tested in clean Ubuntu 18.04.2 LTS VM
sudo apt install git
mkdir workspace
cd workspace
git clone [email protected]:claudiobierig/doppeldenk.git
cd doppeldenk

# Setup database
sudo apt-get install libpq-dev postgresql postgresql-contrib
sudo -u postgres psql
#################### in psql commandline
CREATE USER admin WITH PASSWORD 'admin';
CREATE DATABASE doppeldenk;
\q
####################

sudo apt-get install python3-pip python3-dev
sudo pip3 install virtualenvwrapper
export WORKON_HOME=$HOME/.virtualenvs
export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3
export VIRTUALENVWRAPPER_VIRTUALENV_ARGS=' -p /usr/bin/python3 '
export PROJECT_HOME=$HOME/Devel
source /usr/local/bin/virtualenvwrapper.sh
source ~/.bashrc
#now in virtualenv
mkvirtualenv doppeldenk
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser #user: admin, pw: admin, bypass security for local setup
python manage.py runserver

For deploying to heroku follow the tutorial a bit longer.

# Ubuntu 20
sudo apt-get install python3-lxml

Run Tests

# Testcases only include the correct implementation of the rules
# Testcases also generate printing material
python3 manage.py test

Docker

Setup with docker:

DOCKER_COMPOSE_FILE=docker-compose.yml # or docker-compose.prod.yml. Add the .env files below first.
docker-compose -f $DOCKER_COMPOSE_FILE up -d --build
docker-compose -f $DOCKER_COMPOSE_FILE exec web python manage.py migrate --noinput
docker-compose -f $DOCKER_COMPOSE_FILE exec web python manage.py collectstatic --no-input --clear
docker-compose -f $DOCKER_COMPOSE_FILE exec web python manage.py createsuperuser

Webpage should now be available at http://localhost:8000/ for dev setup or http://localhost:1337/ for prod setup. In prod the following two files need to be added, where the marked variables need to be replaced:

.env.prod

DJANGO_DEBUG=False
SECRET_KEY=***secret_key***
DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
SQL_NAME=***doppeldenk_prod***
SQL_USER=***user***
SQL_PASSWORD=***password***
SQL_HOST=db
SQL_PORT=5432
STATIC_URL=staticfiles

.env.prod.db

POSTGRES_USER=***user***
POSTGRES_PASSWORD=***password***
POSTGRES_DB=***doppeldenk_prod***

Open Points

Listed in TODO.md

Generate Prototype

sudo apt-get install pdfposter
cd printing_material
bash generate_printing_material.sh

The printing material should be located in the same folder. Html pages need to be printed with 200% Zoom.

License

Used artwork and software is listed with the according license in ACKNOWLEDGEMENT.md. The rest of the project is under the MIT license.