README.md

   1 # Platforma Redakcyjna
   2
   3
   4 ## Opis projektu
   5
   6 Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
   7
   8
   9 ## Instalacja i użycie
  10
  11 1. Upewnij się, że masz Pythona w wersji co najmniej 3.5.
  12 2. Stwórz i uruchom wirtualne środowisko:
  13
  14 ```bash
  15 python3 -m venv ve
  16 . ve/bin/activate
  17 ```
  18
  19 3. Przejdź do katalogu serwisu w konsoli
  20 4. Zainstaluj wymagane biblioteki komendą::
  21
  22 ```bash
  23 pip install -r requirements/requirements.txt
  24 ```
  25
  26 5. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
  27
  28 6. Wypełnij bazę danych::
  29
  30 ```bash
  31 src/manage.py migrate
  32 ```
  33
  34 7. Uruchom serwer deweloperski::
  35
  36 ```bash
  37 src/manage.py runserver
  38 ```
  39
  40 8. Strategie wdrożeniowe opisane są w [Dokumentacji Django](http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>).
  41    Do przygotowania wersji do wdrożenia możesz użyć komendy `make deploy`.
  42
  43
  44 ## Testy
  45
  46 ```bash
  47 pip install -r requirements-test.txt
  48 make test
  49 ```
  50
  51 JavaScript (wymagany node.js i xsltproc):
  52
  53 ```bash
  54 npm install
  55 ./node_modules/.bin/mocha -u tdd $(find src -name *_test.js)
  56 ```