root/README

Revision 9, 2.7 kB (checked in by alex, 23 months ago)
  • did I get this right now?!
Line 
1'''''the questionnaire webapp for realists with deadlines'''''
2
3== Django Questionnaire app ==
4
5The Django Questionnaire app allows you to easily set up a working
6questionnaire, complete with email-invitations and CSV export functionality.
7This app allows you to spread your questions over multiple pages (categories),
8and currently supports 4 types of answers.
9
10Django Questionnaire is licensed under the BSD license, and is Free/Open Source Software.
11
12Django Questionnaire is a cleaned-up/slimmed-down version of a framework Aperte
13has developed for various clients. If you want a dedicated, hosted version of
14Django Questionnaire, or if you want a version tailored to your needs, feel
15free to contact Aperte: http://www.aperte-it.com/contact
16
17== Screenshots ==
18
19Check out a few screenshots of the default template & admin: QuestionnaireScreenshots
20
21== Demo install ==
22
23You can freely try out this app!
24
25 * User login: http://djangoquest-demo.aperte-it.com
26 * Admin login: http://djangoquest-demo.aperte-it.com/admin (username: admin, password: test)
27
28Please note that the demo install is refreshed every hour and is to be used
29for demonstration purposes only. Email-invitations sent via the admin aren't
30delivered in order to avoid abuse.
31
32== Install ==
33
34If you don't know what Django is, see http://www.djangoproject.com.
35You won't be able to install Django Questionnaire without Django!
36
37The project is distributed as a Django project directory, with the
38actual questionnaire app in the questionnaire directory and media/template
39directories for the initial views.
40
41 * Make sure you have Django 1.0 or newer installed.
42 * Unpack a source tarball (see QuestionnaireDownloads), or checkout this project (''svn co svn://alextreme.org/djangoquest ./djangoquest'')
43
44 * Modify the ''settings.py'' for your situation, at a minimum:
45   * Add your name/emailaddress to the ADMIN tuple (the first ADMIN is used for sending the invitations)
46   * Change the WORKING_DIRECTORY to the location of your project directory
47   * Change the QUESTIONNAIRE_URL to the domain where you want to host this project (this URL is sent to your users in order to login)
48   * Change the SECRET_KEY variable to something else (any random string will do)
49
50 * Either run ''python manage.py runserver'' in the project directory, or follow the Django instructions for setting up the directory for your webserver.
51
52== Further details ==
53
54An initial SQLite database is included to bring you up to speed. If you want to
55use it under a webserver, make sure the webserver user (www-data in Debian)
56owns the database.
57
58Django Questionnaire is licenced under the BSD license (the same that Django
59uses). Feel free to do with it as you want, see LICENSE for the details.
Note: See TracBrowser for help on using the browser.