README.md

Drummerei - Timetable

Timetable App for Drummerei Open Decks Breakbeat Night at Gaengeviertel in Hamburg, Germany.

Project Overview

This App allows attendees of Drummerei to select a slot of the time table to go on stage and spin some ruff tunes.

Slots are 30min long by default. 8 Slots per night.

Getting Started

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

Features

• automatically creates/reads Cookies to distinguish visitors when they try to edit slots
• automatically creates a PIN when Schedule is saved
• automatically creates a QR code from PIN

TODO

• UI: make slots uneditable for users that already have a slot

Prerequisites

• Python 3.7+
• Django, qrcode, python-dotenv for SECRET_KEY
• pyzbar for testing QR code, needs zbar installed on system
• Virtual environment manager (venv recommended)
• SQLite

Installation

1. Clone the repository:

   git clone https://github.com/dr0nie/drummerei.git
   

2. install dependencies:

   python -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt
   

3. run app with development server:

   source .venv/bin/activate
   sh create_env.sh # create .env file with SECRET_KEY environment variable
   python manage.py migrate # initialize database schema
   python manage.py createsuperuser # create admin user
   python manage.py runserver