classicvalues / alexia-1

Alexia is het borrelbeheersysteem voor de borrelruimtes in de Zilverling op de Universiteit Twente, de Abscint en MBasement.

Alexia

Alexia is the management system for the drink rooms in the Zilverling at the University of Twente, the Abscint and MBasement.

Table of contents

• Prerequisites
• Quick start
• Project structure
• Copyright and license

Prerequisites

• MySQL

  Due to raw SQL in the migrations only MySQL is supported.

• wkhtmltopdf

• xvfb (optional)

  For servers without an X Server.

Quick start

To set up your own copy of Alexia, use the following steps:

• Make sure you have a virtualenv set up.
• Clone the repo: git clone https://github.com/Inter-Actief/alexia.git
• Install the required packages: pip install -r requirements.txt
• Copy the default settings and edit to your likings.
  • cp alexia/conf/settings/local.py.default alexia/conf/settings/local.py
  • vi alexia/conf/settings.py
• Run the migrations: python manage.py migrate
• (optional) Create a super user: python manage.py createsuperuser
• Run it: python manage.py runserver

Project structure

• alexia/ - All Python code
  • api/ - API logic
  • apps/ - Alexia logic
  • conf/wsgi.py - WSGI Application entry
  • conf/settings/local.py.default - Example settings file
• assets/ - CSS/Webfonts/Images/Javascript
• bin/ - Auxiliary scripts
• locale/ - Internationalization
• templates/ - Templates

Copyright and license

Code and documentation copyright 2017 the Alexia Authors. Code released under the BSD 3-Clause License.