Files
django-dav-events/README.rst

79 lines
2.2 KiB
ReStructuredText

ABOUT
=====
This is the DAV Events django project.
REQUIREMENTS
============
- Python 2.7
- Django
- Several additional django related python packages
For production use you surly want a real web server that supports WSGI
(e.g. Apache httpd with mod_wsgi) and a real Database like PostgreSQL.
INSTALLATION
============
1. Python Environment
---------------------
It is strongly recommended to create a separated python environment
for your django project. But it is not exactly necessary.
The creation of a separated python environment is very easy with the
virtualenv tool (a python package).
If you decide to not use virtualenv, confirm_status with step 2.
- Create the python environment in a directory called ./env/python:
``virtualenv --prompt="(dav)" ./env/python``
- If you use a posix compatible shell (like bash, the linux default shell),
you have to enter the environment with the following command:
``source ./env/python/bin/activate``
Your shell prompt should show the prefix '(dav)' now.
Do not leave the environment (nor exit the shell) until the whole
installation is done.
After that you can call the command ``deactivate`` to leave.
If you have left the environment and want to reenter it (e.g. to execute
a python command) use the previous ``source ...`` command.
2. Install files
----------------
* ``python setup.py develop``
* ``django-dav-events-admin setup ./env/django``
The django project directory ('./env/django' within the previous example)
will be called project root for now on.
3. Create the database schema / Populate the database
-----------------------------------------------------
Change into the *project root* (where the file ``manage.py`` lives)
and run
* ``python manage.py makemigrations``
* ``python manage.py migrate``
4. Start test server
--------------------
While you still are in the *project root* directory, run
``python manage.py runserver``
Now you should be able to connect to the test server via
http://localhost:8000
LICENCE
=======
Permission to use, copy, modify, and/or distribute this software
for any purpose with or without fee is hereby granted.