Simpler deployment.

[redakcja.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..47fad0c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+====================
+Platforma Redakcyjna
+====================
+
+Opis projektu
+=============
+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
+
+#. Wypełnij bazę danych (Django poprosi o utworzenie pierwszego użytkownika)::
+
+       ./project/manage.py syncdb
+
+#. Skopiuj zawartość pliku `project/localsettings.sample` do `project/localsettings.py` i zmień go zgodnie ze swoimi potrzebami.
+
+#. Uruchom serwer deweloperski::
+
+       ./project/manage.py runserver
+
+#. 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ę::
+
+       fab staging deploy
+       
+ Aby wdrożyć serwis na serwer produkcyjny wpisz::
+
+       fab production deploy
+