Update docs: Project structure

This commit is contained in:
Raphael Michel
2014-10-04 22:18:53 +02:00
parent 06c387b295
commit 77392b4ab4
+40
View File
@@ -18,3 +18,43 @@ tixlcontrol/
tixlpresale/
This is the django app containing the frontend for users buying tickets.
helpers/
Helpers contain a very few modules providing workarounds for low-level flaws in
Django or installed 3rd-party packages, like a filter to combine the ``lessc``
preprocessor with ``django-compressor``'s URL rewriting.
Language files
--------------
The language files live in ``locale/*/LC_MESSAGES/``.
Static files
-------------
LESS source code
^^^^^^^^^^^^^^^^
We use less as a preprocessor for CSS. Our own less code is built in the same
step as Bootstrap and FontAwesome, so their mixins etc. are fully available.
tixlcontrol
tixlcontrol has two main LESS files, ``tixlcontrol/static/tixlcontrol/less/main.less`` and
``tixlcontrol/static/tixlcontrol/less/auth.less``, importing everything else.
3rd-party assets
^^^^^^^^^^^^^^^^
Bootstrap
Bootstrap lives as a git submodule at ``tixlbase/static/bootstrap/``
Font Awesome
Font Awesome lives as a git submodule at ``tixlbase/static/fontawesome/``
jQuery
jQuery lives as a single JavaScript file in ``tixlbase/static/jquery/js/``
jQuery plugin: Django formsets
Our own modified version of `django-formset-js`_ is available as an independent
django app and installed via pip.
.. _django-formset-js: https://github.com/tixl/django-formset-js