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 #. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
  18
  19         ./project/manage.py syncdb
  20
  21 #. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
  22
  23 #. Uruchom serwer deweloperski::
  24
  25         ./project/manage.py runserver
  26
  27 #. 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>`_.
  28
  29 Wdrożenie
  30 =========
  31 #. Ściągnij i zainstaluj `fabric <http://docs.fabfile.org/>`_
  32 #. Przejdź do katalogu serwisu w konsoli
  33 #. Aby wdrożyć serwis na serwer deweloperski wpisz komendę::
  34
  35         fab staging deploy
  36
  37  Aby wdrożyć serwis na serwer produkcyjny wpisz::
  38
  39         fab production deploy
  40
  41 Testy
  42 ====
  43
  44     $ pip install -r requirements-test.txt
  45     $ python redakcja/manage.py test --settings=settings.test
  46
  47 JavaScript (wymagany node.js i xsltproc):
  48
  49     $ npm install
  50     $ ./node_modules/.bin/mocha -u tdd $(find -name *_test.js)
  51