README 3.17 KB
Newer Older
1

chris's avatar
chris committed
2 3
Nuages - Easy poll sharing
==========================
4

chris's avatar
chris committed
5
 Nuages aims to provide a collaborative meeting poll system, similar to doodle or rdvz. It is build in python, using the django framework and a little of javascript. This application was named after Django's famous song. Feedback and collaboration are welcome at nuage@ domainepublic.net
6

7 8
 The project uses the following django applications:
    - django-registration: https://bitbucket.org/ubernostrum/django-registration
9
    - django-request: https://github.com/kylef/django-request
chris's avatar
chris committed
10

chris's avatar
chris committed
11 12 13
 The project uses the following javascripts:
    - jquery, jquery-ui: http://www.jquery.com/
    - jquery-dynamic-formset: http://code.google.com/p/django-dynamic-formset/
14
    - jquery timepicker addon: https://github.com/trentrichardson/jQuery-Timepicker-Addon
15

chris's avatar
chris committed
16 17
Translation
===========
18

19
Create/update a translation file:
20

21
    # django-admin makemessages -l fr
22

23
Edit and translate the translation file:
24

25
    # gedit locale/fr/LC_MESSAGES/django.po
26

27
Compile translated messages:
28

29
    # django-admin compilemessages
30

chris's avatar
chris committed
31 32
Fast installation
=================
33

34 35 36 37 38 39
Install python-django package (>=1.3)
Clone nuages archive somewhere in your home folder

    # cd
    # git clone http://git.domainepublic.net/git/nuages.git

40
You can have local customizations in the local_settings.py file
41

42 43
    # cp settings.py local_settings.py
    # vi local_settings.py
44

chris's avatar
chris committed
45
Build nuages database
46

47
    # ./manage.py syncdb
48

49
Start the python webserver
50

51
    # ./manage.py runserver
52

53
You should have the application running at http://127.0.0.1:8000
54

chris's avatar
chris committed
55 56
Apache installation
===================
57

58 59 60 61 62 63 64
Install python-django package (>=1.3)
Copy nuages to /usr/local/lib/nuages

    # cd /usr/local/lib
    # git clone http://git.domainepublic.net/git/nuages.git 

Optionally edit project setings and set DEBUG option to False
65

66
    # cd /usr/local/lib/nuages
67
    # vi settings.py
68

chris's avatar
chris committed
69
Build nuages database
70

71
    # cd /usr/local/lib/nuages
72
    # ./manage.py syncdb
73
    # ./manage.py collectstatic
74

75
There are several ways to configure Apache and python, we recommend wsgi, simply install libapache2-mod-wsgi, and add the following to /etc/apache2/sites-available/nuages
76

77
    <VirtualHost *:80>
78
      
79 80 81
      ServerName localhost.locadomain
      Alias /static/ /usr/local/lib/nuages/staticroot/
      WSGIScriptAlias / /usr/local/lib/nuages/apache/django.wsgi
82

83 84 85 86
      <Directory /usr/local/lib/nuages/apache>
              Order allow,deny
              Allow from all
      </Directory>
87

88 89 90 91
      <Directory /usr/local/lib/nuages/staticroot>
        Order deny,allow
        Allow from all
      </Directory>
92

93
    </VirtualHost>
94

95
Adapt the path in file apache/django.wsgi
96

97
Fix permission for apache user
98

99
    sudo chown -R www-data /usr/local/lib/nuages
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114
Email Service
=============

Django is expecting a working SMTP server listening at localhost, sendmail for instance.

Another option is to add attributes in settings.py, this make email work only when there is a localhost server accepting all the email. To change this and make it configurable, we only have to add these lines:

  # Email attributes
  EMAIL_HOST = 'mail.example.com'
  EMAIL_PORT = '25'
  EMAIL_HOST_USER = 'username@example.com'
  EMAIL_HOST_PASSWORD = 'password'
  EMAIL_USE_TLS = False