k4ever/devel/README

56 lines
1.4 KiB
Plaintext

Kassensystem
############
Preamble
========
For ages there has been the discussion - Kassensystem!
So many attempts have been made, so many things have been discussed
and overengineered... But oh well, here is our attempt!
Mighty Kassensystem, finally!
Dependencies
============
- python-django >= 1.3
- python-django-auth-ldap
- python-django-piston
- easy-thumbnails
https://github.com/SmileyChris/easy-thumbnails.git
Installation Process
====================
1. Webserver
Some sort of Webserver is needed to host the django part. All about deploying
django can be found at https://docs.djangoproject.com/en/dev/howto/deployment/
Mostly this will be apache2 + mod_wsgi.
k4ever has static files which should be served by the webserver directly, so
be sure to turn off python for the media/ directory.
For development there is also djangos builtin webserver. You can use it via
./manage.py runserver but THIS SHOULD NEVER BE USED IN A PRODOCTIVE
ENVIRONMENT.
2. The database
- edit settings.py for database
- Add Usergroups: ('Normal User', 'Plugin') ( to be renamed)
- ./manage.py syncdb
- install script for needed data will be written.
Documentation
=============
Yes, there is more documentation than this readme! It is present
at k4ever/docs/, but if you want (and have python-sphinx) installed,
you can compile it to nice html (or pdf, ...) pages. There is a
``Makefile`` present to your assistance.