X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/ec5b493bff5efa683aadf5f78aa891eff3550156..a13d9edcc855910d4339144f83f0e09f6940590f:/README.md diff --git a/README.md b/README.md index 93ffb1c4..5b68e2bd 100644 --- a/README.md +++ b/README.md @@ -8,44 +8,38 @@ Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu Instalacja i użycie =================== -#. Ściągnij i zainstaluj `pip `_ +#. Upewnij się, że masz Pythona w wersji co najmniej 3.5. +#. Stwórz i uruchom wirtualne środowisko: + + python3 -m venv ve + . ve/bin/activate + #. Przejdź do katalogu serwisu w konsoli #. Zainstaluj wymagane biblioteki komendą:: - pip install -r requirements.txt + pip install -r requirements/requirements.txt -#. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika):: +#. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. - ./project/manage.py syncdb +#. Wypełnij bazę danych:: -#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. + src/manage.py migrate #. Uruchom serwer deweloperski:: - ./project/manage.py runserver - -#. Zalecane jest serwowanie aplikacji przez `modwsgi `_ na serwerze `Apache2 `_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django `_. - -Wdrożenie -========= -#. Ściągnij i zainstaluj `fabric `_ -#. Przejdź do katalogu serwisu w konsoli -#. Aby wdrożyć serwis na serwer deweloperski wpisz komendę:: + src/manage.py runserver - fab staging deploy - - Aby wdrożyć serwis na serwer produkcyjny wpisz:: +#. Strategie wdrożeniowe opisane są w `Dokumentacji Django `_. + Do przygotowania wersji do wdrożenia możesz użyć komendy `make deploy`. - fab production deploy Testy ==== $ pip install -r requirements-test.txt - $ python redakcja/manage.py test --settings=settings.test + $ make test JavaScript (wymagany node.js i xsltproc): $ npm install - $ ./node_modules/.bin/mocha -u tdd $(find -name *_test.js) - \ No newline at end of file + $ ./node_modules/.bin/mocha -u tdd $(find src -name *_test.js)