From b13e2a4009fede008923183585cc52004476f0af Mon Sep 17 00:00:00 2001
From: Romain Gauthier <romain.gauthier@monkeypatch.me>
Date: Fri, 23 Mar 2012 23:11:44 +0100
Subject: [PATCH] [doc] Add documentation to setup the project.

---
 README.md     | 10 +++++++++
 docs/SETUP.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+)
 create mode 100644 README.md
 create mode 100644 docs/SETUP.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2669278
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+nnmon the bugtracker for teh internetz
+======================================
+
+nnmon is the project running [respectmynet.eu](http://respectmynet.eu/).
+
+Installation
+------------
+
+See /docs/SETUP.md
+
diff --git a/docs/SETUP.md b/docs/SETUP.md
new file mode 100644
index 0000000..1309ead
--- /dev/null
+++ b/docs/SETUP.md
@@ -0,0 +1,60 @@
+SETUP
+=====
+
+This describes how to setup the nnmon dev environment
+
+Install the base dependencies
+-----------------------------
+
+Install the following packages:
+
+    sudo aptitude install python-sqlite python-ooolib
+
+Install the base python virtualenv tools:
+
+    sudo apt-get install python-setuptools
+    sudo pip install virtualenv
+    sudo pip install virtualenvwrapper
+
+
+You don't use the virtualenv/virtualenvwrapper tools yet
+--------------------------------------------------------
+
+Create a directory to hold the virtual environments:
+
+    mkdir ~/.virtualenvs
+
+Add to your .bashrc (or equivalent) the following lines:
+
+    export WORKON_HOME=$HOME'/.virtualenvs'
+    source /usr/local/bin/virtualenvwrapper.sh
+
+Then run the following command:
+
+    source ~/.bashrc
+
+This will end up creating (relatively large) folders in ~/.virtualenvs
+where all the projet dependencies will be installed.
+
+
+Setup your virtual environment
+-----------------------------
+
+Create the virtualenv for nnmon and workon it:
+
+    mkvirtualenv --system-site-packages --distribute nnmon
+
+Install nnmon's depdendencies:
+
+    pip install -r pip-requirements.txt
+
+
+Run the server
+--------------
+
+    cd ../nnmon
+    python manage.py syncdb # run the database migrations
+    python manage.py runserver 8080
+
+Your application is available on http://localhost:8080/
+
-- 
GitLab