0c05ea6cadfc2cce2bd6ef9d86eedae57800d751
[redakcja.git] / 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/requirements.txt
16
17 #. Wypełnij bazę danych::
18
19         src/manage.py migrate
20
21 #. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
22
23 #. Uruchom serwer deweloperski::
24
25         src/manage.py runserver
26
27 #. Strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.
28
29
30 Testy
31 ====
32
33     $ pip install -r requirements-test.txt
34     $ make test
35
36 JavaScript (wymagany node.js i xsltproc):
37
38     $ npm install
39     $ ./node_modules/.bin/mocha -u tdd $(find src -name *_test.js)