svn commit: r1668510 - /steve/steve-web/README.rst

[ad...@apache.org]

Author: adc
Date: Mon Mar 23 02:32:01 2015
New Revision: 1668510

URL: http://svn.apache.org/r1668510
Log:
Some rough instructions on how to start things up

Modified:
    steve/steve-web/README.rst

Modified: steve/steve-web/README.rst
URL: http://svn.apache.org/viewvc/steve/steve-web/README.rst?rev=1668510&r1=1668509&r2=1668510&view=diff
==============================================================================
--- steve/steve-web/README.rst (original)
+++ steve/steve-web/README.rst Mon Mar 23 02:32:01 2015
@@ -1,6 +1,25 @@
-=============
-Panopticon
-=============
+============
+Apache STeVe
+============
 
-.. rubric:: Panopticon.
+.. rubric:: Apache STeVe.
 
+Running Web Site
+----------------
+
+You need to have ``pip`` and ``virtialenv`` installed on your machine.
+In the local directory of ``steve/steve-web``:
+
+#. ``virtualenv --python=python2.6 .virtualenv``
+#. ``source .virtualenv/bin/activate``
+#. ``pip install -r requirements.txt``
+#. ``pip install --editable .``
+#. ``pip install uwsgi``
+#. ``uwsgi uwsgi.ini``
+
+Browse http://127.0.0.1:8080/admin and click "Create a new election".
+Note, that the pages do not exactly work but are meant to be representative
+of how clean the code can be when Flask is used.
+
+Also note the general organization of the project which pretty much follows
+how many Python projects organize their code and tests.