Changeset - c60fb2199532
[Not reviewed]
default
0 2 1
Branko Majic (branko) - 11 years ago 2013-05-24 00:09:27
branko@majic.rs
Fixed a couple of errors. Finished the quick-start guide for Debian/Ubuntu. Added empty usage document.
3 files changed with 69 insertions and 2 deletions:
0 comments (0 inline, 0 general)
docs/installation.rst
Show inline comments
 
@@ -17,7 +17,7 @@ the following command::
 
In order to install the latest development version of Django Conntrackt from
 
Mercurial repository, use the following command::
 

	
 
 pip install -e hg+https://hg.majic.rs/conntrackt/
 
 pip install -e hg+https://hg.majic.rs/conntrackt#egg=conntrackt
 

	
 
After this you should proceed to :ref:`configure your Django installation <configuring-django>`.
 

	
docs/quickstart.rst
Show inline comments
 
@@ -8,14 +8,77 @@ Debian/Ubuntu
 
-------------
 

	
 
Install the *pip* utility::
 

	
 
  sudo apt-get install pip
 

	
 
Install the *virtualenv* and *virtualenvwrapper*::
 

	
 
  sudo apt-get install python-virtualenv virtualenvwrapper
 

	
 
Create the virtual environment for testing Django Conntrackt::
 

	
 
  mkvirtualenv conntrackt
 

	
 
Install the Django Conntrackt requirements::
 

	
 
  workon conntrackt
 
  pip install
 
  pip install django
 

	
 
Install Django Conntrackt::
 

	
 
  pip install -e hg+https://hg.majic.rs/conntrackt#egg=conntrackt
 

	
 
Start a new Django Conntrackt project::
 

	
 
  django-admin.py startproject conntrackt_test
 

	
 
Edit configuration file ``conntrackt_test/conntrackt_test/settings.py`` to set-up
 
some basic settings:
 

	
 
#. Under ``DATABASES`` set parameter ``ENGINE`` to ``'django.db.backends.sqlite3'``.
 
#. Under ``DATABASES`` set parameter ``NAME`` to ``'conntrackt_test.sqlite'``.
 
#. Under ``INSTALLED_APPS`` uncomment the line ``'django.contrib.admin'``.
 
#. Under ``INSTALLED_APPS`` append line ``'conntrackt',``.
 
#. Append the following lines to the end of the file::
 

	
 
     from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS
 
     TEMPLATE_CONTEXT_PROCESSORS += (
 
         "django.core.context_processors.request",
 
     )
 

	
 

	
 
Edit the URL configuration file ``conntrackt_test/conntrackt_test/urls/.py`` to
 
set-up the URLs for the admin website and Conntrackt itself:
 

	
 
#. At the top of the file, add line ``from django.http import HttpResponseRedirect``.
 
#. Uncomment line ``from django.contrib import admin``.
 
#. Uncomment line ``admin.autodiscover()``.
 
#. Uncomment line ``url(r'^admin/', include(admin.site.urls)),``
 
#. Under ``urlpatterns`` append lines::
 

	
 
     url(r'^$', lambda r : HttpResponseRedirect('conntrackt/')),
 
     url(r'^conntrackt/', include('conntrackt.urls')),
 

	
 
Set-up the database for the project::
 

	
 
  python manage.py syncdb
 

	
 
You will be prompted to provide some additional information:
 

	
 
#. When prompted to create a superuser, answer ``yes``.
 
#. Provide the desired username when prompted for it.
 
#. Provide the desired e-mail address when prompted for it.
 
#. Provide the desired password for created user.
 

	
 
After this the project is fully configured to run Django Conntrackt. Run the
 
Django development server (good enough for testing, but don't use it in
 
production)::
 

	
 
  python manage.py runserver
 

	
 
You can now explore the functionality of Djang Conntrackt at::
 
  http://localhost:8000/
 

	
 
If you have any problems getting around and understanding how the applications
 
works, have a look at the :ref:`usage guide <usage>`.
 

	
docs/usage.rst
Show inline comments
 
new file 100644
 
.. _usage:
 
Usage
 
=====
 

	
0 comments (0 inline, 0 general)