README.md

   1 ====================
   2 Platforma Redakcyjna
   3 ====================
   4
   5 Opis projektu
   6 =============
   7 Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
   8
   9 Instalacja i użycie
  10 ===================
  11 #. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
  12 #. Przejdź do katalogu serwisu w konsoli
  13 #. Zainstaluj wymagane biblioteki komendą::
  14
  15         pip install -r requirements.txt
  16
  17 #. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
  18
  19 #. Pobierz edytor::
  20
  21     git submodule update --init
  22
  23 #. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
  24
  25         ./project/manage.py syncdb --migrate
  26
  27 #. Uruchom serwer deweloperski::
  28
  29         ./project/manage.py runserver
  30
  31 #. 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>`_.
  32
  33 Wdrożenie
  34 =========
  35 #. Ściągnij i zainstaluj `fabric <http://docs.fabfile.org/>`_
  36 #. Przejdź do katalogu serwisu w konsoli
  37 #. Aby wdrożyć serwis na serwer deweloperski wpisz komendę::
  38
  39         fab staging deploy
  40
  41  Aby wdrożyć serwis na serwer produkcyjny wpisz::
  42
  43         fab production deploy
  44
  45 Testy
  46 ====
  47
  48     $ pip install -r requirements-test.txt
  49     $ python redakcja/manage.py test --settings=settings.test
  50
  51 JavaScript (wymagany node.js i xsltproc):
  52
  53     $ npm install
  54     $ ./node_modules/.bin/mocha -u tdd $(find -name *_test.js)
  55