X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/d0deb0f3bebb42475b2b04d0ce389160cc219e44..d64a8451dafc98e8f71455a55d123d22f3368ef9:/README.rst diff --git a/README.rst b/README.rst index 9734694a..47fad0c8 100644 --- a/README.rst +++ b/README.rst @@ -1,37 +1,40 @@ +==================== Platforma Redakcyjna ==================== Opis projektu -************* +============= Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl. -Wymagania -********* -* `Django 1.1 `_ -* `django-piston 0.2.3rc1 `_ -* `librarian 1.2 `_ -* `lxml 2.2.2 `_ -* `Mercurial 1.3.1 `_ -* `PIL 1.1.6 `_ (wymagane przez skrypt imgconv.py) -* `pngnq `_ (wymagane przez skrypt imgconv.py) +Instalacja i użycie +=================== +#. Ściągnij i zainstaluj `pip `_ +#. Przejdź do katalogu serwisu w konsoli +#. Zainstaluj wymagane biblioteki komendą:: + + pip install -r requirements.txt + +#. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika):: -Instalacja -********** -1. Ściągnij i zainstaluj `pip `_ -2. Przejdź do katalogu serwisu w konsoli -3. Zainstaluj wymagane biblioteki (patrz sekcja wymagania_) komendą:: + ./project/manage.py syncdb - pip install -f http://redmine.nowoczesnapolska.org.pl/projects/librarian/files -r requirements.txt +#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. -4. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika):: +#. Uruchom serwer deweloperski:: - ./manage.py syncdb + ./project/manage.py runserver -5. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. +#. Zalecane jest serwowanie aplikacji przez `modwsgi `_ na serwerze `Apache2 `_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django `_. -6. Uruchom serwer deweloperski:: +Wdrożenie +========= +#. Ściągnij i zainstaluj `fabric `_ +#. Przejdź do katalogu serwisu w konsoli +#. Aby wdrożyć serwis na serwer deweloperski wpisz komendę:: - ./manage.py runserver + fab staging deploy + + Aby wdrożyć serwis na serwer produkcyjny wpisz:: -7. Zalecane jest serwowanie aplikacji przez `modwsgi `_ na serwerze `Apache2 `_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django `_. + fab production deploy