README.md



AK Planning

Description
AKPlanning is a tool used for modeling, submitting, scheduling and displaying AKs (German: Arbeitskreise), meaning workshops, talks or similar slot-based events.
It was built for KIF (German: Konferenz der deutschsprachigen Informatikfachschaften), refer to the wiki for more Information.

Setup
This repository contains a Django project with several apps.

Requirements
AKPlanning has two types of requirements: System requirements are dependent on operating system and need to be installed manually beforehand. Python requirements will be installed inside a virtual environment (strongly recommended) during setup.

System Requirements

Python 3.7 incl. development tools
Virtualenv
for production using uwsgi:

C compiler e.g. gcc
uwsgi Python3 plugin


for production using Apache (in addition to uwsgi)

the mod proxy uwsgi plugin for apache2


Python Requirements
Python requirements are listed in requirements.txt. They can be installed with pip using -r requirements.txt.

Development Setup

create a new directory that should contain the files in future, e.g. mkdir AKPlanning

change into that directory cd AKPlanning

clone this repository git clone URL .


Automatic Setup

execute the setup bash script Utils/setup.sh


Manual Setup

setup a virtual environment using the proper python version virtualenv env -p python3.7

activate virtualenv source env/bin/activate

install python requirements pip install -r requirements.txt

setup necessary database tables etc. python manage.py migrate

create a priviledged user, credentials are entered interactively on CLI python manage.py createsuperuser

deactivate virtualenv deactivate


Development Server
To start the application for development use python manage.py runserver 0:8000 from the root directory.
Do not use this for deployment!