Add depot for building packages.

[redakcja.git] / README.md

diff --git a/README.md b/README.md
index 47fad0c..5869653 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +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.
 
 Platforma to serwis służący do grupowej edycji książek na potrzeby serwisu WolneLektury.pl.
 

-Instalacja i użycie
-===================
-#. Ściągnij i zainstaluj `pip <http://pypi.python.org/pypi/pip>`_
-#. Przejdź do katalogu serwisu w konsoli
-#. Zainstaluj wymagane biblioteki komendą::

 
 

-       pip install -r requirements.txt
+## 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
+```
+
+3. Przejdź do katalogu serwisu w konsoli
+4. Zainstaluj wymagane biblioteki komendą::
+
+```bash
+pip install -r requirements/requirements.txt
+```
+
+5. Skopiuj zawartość pliku `src/redakcja/localsettings.sample` do `src/redakcja/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.

 
 

-#. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
+6. Wypełnij bazę danych::

 
 

-       ./project/manage.py syncdb
+```bash
+src/manage.py migrate
+```

 
 

-#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
+7. Uruchom serwer deweloperski::

 
 

-#. Uruchom serwer deweloperski::
+```bash
+src/manage.py runserver
+```

 
 

-       ./project/manage.py runserver
+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`.

 
 

-#. Zalecane jest serwowanie aplikacji przez `modwsgi <http://code.google.com/p/modwsgi/>`_ na serwerze `Apache2 <http://httpd.apache.org/>`_ przy pomocy załączonego skryptu `dispatch.fcgi`. Inne strategie wdrożeniowe opisane są w `Dokumentacji Django <http://docs.djangoproject.com/en/dev/howto/deployment/#howto-deployment-index>`_.

 
 

-Wdrożenie
-=========
-#. Ściągnij i zainstaluj `fabric <http://docs.fabfile.org/>`_
-#. Przejdź do katalogu serwisu w konsoli
-#. Aby wdrożyć serwis na serwer deweloperski wpisz komendę::
+## Testy

 
 

-       fab staging deploy
-       
- Aby wdrożyć serwis na serwer produkcyjny wpisz::
+```bash
+pip install -r requirements-test.txt
+make test
+```

 
 

-       fab production deploy
+JavaScript (wymagany node.js i xsltproc):

 
 

+```bash
+npm install
+./node_modules/.bin/mocha -u tdd $(find src -name *_test.js)
+```