Diplomacy

A web browser version of the classic strategy board game Diplomacy.

We are fans of the game and enjoy playing on the existing web versions like Play Diplomacy, Backstabbr, and others. We decided to build a new version of the game to try to bring together and improve on some of the features of the existing versions. We also wanted to make the project open source so that it could be maintained by an enthusiastic community of diplomacy fans.

Overview

This project consists of the following main components:

• core - This is the Django app that powers the project's back end. This is where the models are defined. All functionality relating to the database lives here.

• adjudicator - In diplomacy, at the end of every turn the orders that each player has submitted are interpreted and the board is updated. adjudicator is a python package which interprets an in-game turn and returns the outcome of the orders. The outcome is then interpreted by core and the state of the game is updated accordingly.

• service - This is a Django Rest Framework app that provides the API through which the client application can interact with core.

• client - This is React JS app that acts as the front end of the project. The client app is contained in a separate repo.

Getting started

These instructions will get you started with a copy of the project up on your local machine for development and testing purposes.

Docker set up

Prerequisites

This set up uses Docker and Docker Compose for local development. Follow the docs to get Docker and Docker Compose installed.

Note the docker set up has only been tested for Unix systems. If you are using Windows, follow the non-docker set up instructions.

Configuration

Run the following commands from the root directory to create local copies of configuration files:

• Run cp project/settings/local.example.py project/settings/local.py
• Run cp docker-compose.override.example.yml docker-compose.override.yml

Bring up local copy

• Run docker-compose up to bring up the project (You can run detached by adding -d flag)
• Once the containers are up you can run commands from inside the docker service container by running docker exec -it diplomacy_diplomacy.service_1 and then running whatever command you like.

Loading fixtures for development

To load the fixtures run make reset_db && make dev_fixtures && make superuser from the root directory (outside container). This resets the database, builds the fixtures in fixtures/dev and creates a superuser with the following credentials:

Username: admin
Pw: admin

You can sign into the client and the service using these credentials.

Non-docker set up

Note this set up has been tested with Windows

Prerequisites

Ensure that you have installed virtualenv, rabbitmq, and make.

Virtual environent

Create a virtual environment:

python -m virtualenv venv

Activate the virtual environment:

# Unix
source venv/bin/activate

# Windows - Note if you are using the terminal in VSCode you can select the
# python interpreter at the bottom left of the screen (requires Python extension)
venv\Scripts\activate.bat

Install requirements:

pip install --user -r requirements.txt -r dev_requirements.txt

Configuration

Run the following command from the root directory to create local copies of configuration files:

# Unix
cp project/settings/local.example.py project/settings/local.py

# Windows
cp .\project\settings\local.example.py .\project\settings\local.py

Open the local.py file and edit uncomment each section labeled "non Docker setup" and comment out the sections labeled "Docker setup"

Bring up development server

Run the development server on port 8082. This is what the client expects during deevelopment.

# Unix
python ./manage.py runserver localhost:8082

# Windows
python .\manage.py runserver localhost:8082

Loading fixtures for development

To load the fixtures run make fixtures_local from the root directory. This builds the fixtures in fixtures/dev and creates a superuser with the following credentials:

Username: admin
Pw: admin

You can sign into the client and the service using these credentials.

Bring up rabbitmq worker

You must bring up a rabbitmq instance to enable celery tasks. This is required by models.TurnManager.new which create a models.TurnEnd instance.

On windows you can install rabbitmq using choco install rabbitmq. Once installed, a rabbitmq instance is automatically started on the port specified in settings/local.example.py.

Running the tests

From within the service container run python3 manage.py test.

Linting

Run flake8 to check for code style problems. Run flake8 . from the project root. If there are code style problems they will be displayed.

Test Coverage

To generate a test coverage report test coverage, run coverage run manage.py test from within the container. Then run coverage report to see the results.