Doc: Structure and concepts

This commit is contained in:
Raphael Michel
2014-09-09 17:52:10 +02:00
parent a5b1e28d8f
commit bf1c64da84
3 changed files with 40 additions and 0 deletions

View File

@@ -0,0 +1,18 @@
Implementation Concepts
=======================
Basic terminology
-----------------
Tixl is a sofware selling **Items**, an abstract thing which is related to an **Event**. Every Event is managed by the **Organizer**, who runs the event.
Tixl know two types of **Users**:
**Local users**
Local users do only exist inside the scope of one event. They are identified by usernames, which are only valid for exactly one event.
**Global users**
Global users exist everywhere in the installation of Tixl. They can buy tickets for multiple events and they can be managers of one or more Organizers/Events. Global users are identified by e-mail addresses.
For more information about this user concept and reasons behind it, see the docstring of the ``tixlbase.models.User`` class.

View File

@@ -7,4 +7,6 @@ Contents:
:maxdepth: 2
goals
concepts
setup
structure

View File

@@ -0,0 +1,20 @@
Project structure
=================
Python source code
------------------
All the source code lives in ``src/``, which has several subdirectories.
tixl/
This directory contains the basic Django settings and URL routing. It is
tixlbase/
This is the django app containing all the models and methods which are
essential to all of tixl's features.
tixlcontrol/
This is the django app containing the frontend for organizers.
tixlpresale/
This is the django app containing the frontend for users buying tickets.