Merge branch 'master' of stigma:platforma
[redakcja.git] / README.rst
1 Platforma Redakcyjna
2 ====================
3
4 Opis projektu
5 *************
6 Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
7
8 Wymagania
9 *********
10 * `Django 1.1 <http://djangoproject.com/>`_
11 * `django-piston 0.2.3rc1 <http://bitbucket.org/jespern/django-piston/>`_
12 * `librarian 1.2 <http://redmine.nowoczesnapolska.org.pl/projects/show/librarian>`_
13 * `lxml 2.2.2 <http://codespeak.net/lxml/>`_
14 * `Mercurial 1.3.1 <http://www.selenic.com/mercurial/>`_
15 * `PIL 1.1.6 <http://www.pythonware.com/products/pil/>`_ (wymagane przez skrypt imgconv.py)
16 * `pngnq <http://pngnq.sourceforge.net/>`_ (wymagane przez skrypt imgconv.py)
17 * `zuber/django-cas-consumer <http://github.com/zuber/django-cas-consumer>`_ (wymagane do autoryzacji przez CAS)
18
19 Instalacja
20 **********
21 1. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
22 2. Przejdź do katalogu serwisu w konsoli
23 3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą::
24
25         pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt
26
27 4. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
28
29         ./manage.py syncdb
30
31 5. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
32
33 6. Uruchom serwer deweloperski::
34
35         ./manage.py runserver
36
37 7. Zalecane jest serwowanie aplikacji przez `modwsgi <http://code.google.com/p/modwsgi/>`_ na serwerze `Apache2 <http://httpd.apache.org/>`_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.
38