Skip to content
Snippets Groups Projects
Select Git revision
  • kifplan
  • master default protected
  • felix-master-patch-23151
3 results
Compare
Forked from KIF / AKPlanning
882 commits behind the upstream repository.
N. Geisler's avatar
add utility scripts
Nadja Geisler authored 
add Utils directory
add Utils README
add setup script
add check script
add update script
document usages in top-level README
25b4e71e
History
N. Geisler's avatar 25b4e71e
History
Name Last commit Last update
AKModel
AKPlanning
Utils
.gitignore
README.md
manage.py
requirements.txt
README.md

AK Planning

Description

AKPlanning is a tool used for modeling, submitting, scheduling and display 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
  • Virtualenv

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

  1. execute the setup bash script Utils/setup.sh

Manual Setup

  1. setup a virtual environment using the proper python version virtualenv env -p python3.7
  2. activate virtualenv source env/bin/activate
  3. install python requirements pip install -r requirements.txt
  4. setup necessary database tables etc. python manage.py migrate
  5. create a priviledged user, credentials are entered interactively on CLI python manage.py createsuperuser
  6. 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!

In your browser, access http://127.0.0.1:8000/wannaDB/ and continue from there.

Updates

To update the setup to the current version on the main branch of the repository use the update script Utils/update.sh or Utils/update.sh --prod in production.

Afterwards, you may check your setup by executing Utils/check.sh or Utils/check.sh --prod in production.