5b68e2bd4c55869e7e883b1e63f27b14d4456043
[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 #. Upewnij się, że masz Pythona w wersji co najmniej 3.5.
12 #. Stwórz i uruchom wirtualne środowisko:
13
14         python3 -m venv ve
15         . ve/bin/activate
16
17 #. Przejdź do katalogu serwisu w konsoli
18 #. Zainstaluj wymagane biblioteki komendą::
19
20         pip install -r requirements/requirements.txt
21
22 #. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
23
24 #. Wypełnij bazę danych::
25
26         src/manage.py migrate
27
28 #. Uruchom serwer deweloperski::
29
30         src/manage.py runserver
31
32 #. Strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.
33    Do przygotowania wersji do wdrożenia możesz użyć komendy `make deploy`.
34
35
36 Testy
37 ====
38
39     $ pip install -r requirements-test.txt
40     $ make test
41
42 JavaScript (wymagany node.js i xsltproc):
43
44     $ npm install
45     $ ./node_modules/.bin/mocha -u tdd $(find src -name *_test.js)