Novell Snoek 31/Jul/2012

Contacts
========

yfjiang ysun sqiu AaaT suse DOT com (to avoid spam
spread, please pronounce them and translate.)

Usage
=====

Activities
----------

        1. Login the web site and click an activity you are interested in

        2. Attend the vote by clicking Take Vote section

                - You could only have one chance of voting at the moment

                - You will not be able to vote for an activity if it is
                  outdated

        3. The statistics of votings are shown in the section Voting
        Results

                - If only one vote is in the activity, there will be only
                  one table to describe the results

                - If multiple votes are created in the activity, multiple
                  tables would be generated to describe:

                        a. 1 dimension data for each votes

                        b. 2 dimension data for for possible combinations
                        of any two of the votes

                - All voters' favourite choice can be found by clicking
                  'Who vote what' link

        4. The ODF format of voting results can be downloaded by click
        'Download me'

        5. You may change your password by clicking the tiny icon beside
        the user name

Meeting Room Reservation
------------------------


Library
-------

    USAGE:

        1. first add book reader in http://site/admin/ to ad a book reader
            
        2. choose book reader in EDIT

Development Guide
=================

Get Code
--------

If you want to push the increnmental change of snoek, please send your public
ssh key to any of the contacts. You can retrieve the code by any of the
method:

    git clone http://147.2.207.136/repo/snoek.git
    git clone ssh://git@147.2.207.136/~/snoek.git

Prerequisite
------------

    * Python>=2.6 (core python)

    * Django==1.2.4 ( python module )

    * Odfpy==0.9.2 ( python module )

    * celery==2.5.3 ( python module )
    
    * django-celery==2.5.5 ( python module )

    * kombu==2.1.8 ( python module )

    * A static http server (apache, lighttp, etc.)    

    *notice*

        it is highly suggested to use 'pip install' to install python modules.

Hosting static content
----------------------

2. Link the static content (css, image) to the root of your http server.

        snoek/$ sudo ln -s $(readlink -f ./media) $your_static_http_root

    The following is a substantial example of my development environment. My
    static http root is in /srv/www/htdoc

        $ find /srv/www/htdocs/ -maxdepth 1 -type l | xargs ls -l

        lrwxrwxrwx 1 root root 32 2012-07-30 13:28 /srv/www/htdocs/media -> /home/yifan/project/snoek/media/

Create settings.py
------------------

    1) Make a Copy settings.py.sample

        snoek/$ cp settings.py.sample .

    2) To edit settings.py for your own testing environment, usually you only
    need to modify the MEDIA_URL value:

        MEDIA_URL = 'http://localhost/media/'

    make it point to your static server's root URL. This makes the css, image,
    jquery canbe imported to Snoek.

Create database
---------------

    It is fairly simple to start a new empty database in snoek:

        snoek/$ python manage.py syncdb

    * Notice: you will be asked to set a super user's password of the
      database.

    Meanwhile we also provide a sample database with test data populated for
    your experiments, to make use of it, simple make a copy:

        snoek/$ cp db.sqlite.sample db.sqlite

Run testing server
------------------

   snoek/$ python manage.py runserver celyryd # this is particularly for library module
   
   snoek/$ python manage.py runserver localhost:8080

Play snoek
----------

    1) Open you browser and visit the url:

        http://localhost:8080/admin

        Login with the super user you set in the Step 4 and try to create
        several users in the adminitration pages.

    2) Open you browser and visit the url:

        http://localhost:8080

        Normally you can play with Snoek now!

Patch submission process
------------------------

   - You did some nice work of code improvement

   - snoek/$ git commit -a -m 'your tips goes here'

   - snoek/$ git pull -r

   - snoek/$ git push

If you are interested but do not have a ssh permission, please send a
patch to any of the contacts via:

    [quote from libreoffice community]
    * create the patch file that you want to mail.  If you are in one
    repository you can use git directly to get e.g. the last change in your
    branch as a diff file with:

           git format-patch HEAD~1