forked from CGM_Public/pretix_original
Doc: Structure and concepts
This commit is contained in:
18
doc/development/concepts.rst
Normal file
18
doc/development/concepts.rst
Normal 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.
|
||||
|
||||
@@ -7,4 +7,6 @@ Contents:
|
||||
:maxdepth: 2
|
||||
|
||||
goals
|
||||
concepts
|
||||
setup
|
||||
structure
|
||||
|
||||
20
doc/development/structure.rst
Normal file
20
doc/development/structure.rst
Normal 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.
|
||||
Reference in New Issue
Block a user