X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/a13d9edcc855910d4339144f83f0e09f6940590f..5fa4673581da8c9ebe6ff327c4520989a6675c8c:/README.md diff --git a/README.md b/README.md index 5b68e2bd..58696533 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,56 @@ -==================== -Platforma Redakcyjna -==================== +# Platforma Redakcyjna + + +## Opis projektu -Opis projektu -============= Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl. -Instalacja i użycie -=================== -#. Upewnij się, że masz Pythona w wersji co najmniej 3.5. -#. Stwórz i uruchom wirtualne środowisko: - python3 -m venv ve - . ve/bin/activate +## Instalacja i użycie + +1. Upewnij się, że masz Pythona w wersji co najmniej 3.5. +2. Stwórz i uruchom wirtualne środowisko: + +```bash +python3 -m venv ve +. ve/bin/activate +``` -#. Przejdź do katalogu serwisu w konsoli -#. Zainstaluj wymagane biblioteki komendą:: +3. Przejdź do katalogu serwisu w konsoli +4. Zainstaluj wymagane biblioteki komendą:: - pip install -r requirements/requirements.txt +```bash +pip install -r requirements/requirements.txt +``` -#. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. +5. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami. -#. Wypełnij bazę danych:: +6. Wypełnij bazę danych:: - src/manage.py migrate +```bash +src/manage.py migrate +``` -#. Uruchom serwer deweloperski:: +7. Uruchom serwer deweloperski:: - src/manage.py runserver +```bash +src/manage.py runserver +``` -#. Strategie wdrożeniowe opisane są w `Dokumentacji Django `_. +8. Strategie wdrożeniowe opisane są w [Dokumentacji Django](http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>). Do przygotowania wersji do wdrożenia możesz użyć komendy `make deploy`. -Testy -==== +## Testy - $ pip install -r requirements-test.txt - $ make test +```bash +pip install -r requirements-test.txt +make test +``` JavaScript (wymagany node.js i xsltproc): - $ npm install - $ ./node_modules/.bin/mocha -u tdd $(find src -name *_test.js) +```bash +npm install +./node_modules/.bin/mocha -u tdd $(find src -name *_test.js) +```