Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 133 lines (94 sloc) 4.3 kb
f26df0a @fwenzel oops, Firefox Input, not Mozilla Input
fwenzel authored
1 Firefox Input
e6eae89 @fwenzel Production app will be called Mozilla Input. Codename remains reporter.
fwenzel authored
2 =============
f22df3b @fwenzel README file.
fwenzel authored
3
6e6fe4c @fwenzel freeing product details from the claws of the reporter app.
fwenzel authored
4 Firefox Input is a [Django][Django]-based web application to gather user
5 feedback from the [Mozilla][Mozilla] Firefox beta testing program.
f22df3b @fwenzel README file.
fwenzel authored
6
7 For project goals, specifications, etc., check out the
8 [Reporter Wiki Page][wikimo].
9
10 [Mozilla]: http://www.mozilla.org
11 [Django]: http://www.djangoproject.com/
e6eae89 @fwenzel Production app will be called Mozilla Input. Codename remains reporter.
fwenzel authored
12 [wikimo]: https://wiki.mozilla.org/Firefox/Input
f22df3b @fwenzel README file.
fwenzel authored
13
14 Getting Started
15 ---------------
16 ### Python
17 You need Python 2.6. Also, you probably want to run this application in a
18 [virtualenv][virtualenv] environment.
19
6b762b8 @fwenzel messing around with requirements to accommodate a vendor lib
fwenzel authored
20 Run
21
22 easy_install pip
23
24 followed by
25
26 pip install -r requirements/prod.txt -r requirements/compiled.txt
27
f22df3b @fwenzel README file.
fwenzel authored
28 to install the required Python libraries.
29
30 [virtualenv]: http://pypi.python.org/pypi/virtualenv
31
1a17b5f @fwenzel (hopefully) removed all traces of haystack.
fwenzel authored
32 ### Sphinx
33
34 For searching, we use [Sphinx][sphinx]. Set up an instance of it, and adjust
35 the SPHINX\_\* settings in settings.py to match your setup. There are three
36 management commands to go with it:
37
38 * ``start_sphinx`` starts the sphinx daemon
39 * ``stop_sphinx`` stops it
40 * ``update_index`` updates the search index (see below)
41
42 [sphinx]: http://www.sphinxsearch.com/
43
f22df3b @fwenzel README file.
fwenzel authored
44 ### Django
5fd6c3b @davedash DB instructions
davedash authored
45 Put your database settings in `settings_local.py`:
46
47 from settings import *
48
49 # ...
50
51 DATABASES = {
52 'default': {
53 'ENGINE': 'mysql',
54 'NAME': 'firefox_input',
55 'USER': 'root',
56 'PASSWORD': '',
57 'HOST': 'localhost',
58 'PORT': '',
59 'OPTIONS': {'init_command': 'SET storage_engine=InnoDB',
60 'charset' : 'utf8',
61 'use_unicode' : True,
62 },
63 }
64 }
65
6e6fe4c @fwenzel freeing product details from the claws of the reporter app.
fwenzel authored
66 To initialize the database, run:
67
68 ./manage.py syncdb
69
70 and to fetch the initial product details data, run:
71
72 ./manage.py update_product_details
73
1a17b5f @fwenzel (hopefully) removed all traces of haystack.
fwenzel authored
74 Finally, to initialize the search index, run:
7ab592a @fwenzel half-done search page. Need: aggregates, narrowing options.
fwenzel authored
75
1a17b5f @fwenzel (hopefully) removed all traces of haystack.
fwenzel authored
76 ./manage.py update_index
7ab592a @fwenzel half-done search page. Need: aggregates, narrowing options.
fwenzel authored
77
f22df3b @fwenzel README file.
fwenzel authored
78 The Internet has plenty of of documentation on setting up a Django application
79 with any web server. If you need a wsgi entry point, you can find one in
80 ``wsgi/reporter.wsgi``.
81
7ab592a @fwenzel half-done search page. Need: aggregates, narrowing options.
fwenzel authored
82 ### Cron jobs
83 There are two jobs you want to run periodically:
84
85 ./manage.py update_product_details # Mozilla Product Details update
86 ./manage.py update_index # update search index
87
88 The frequency is up to you, but you probably want to run the search index
89 updates relatively frequently, while the product details can wait a little
90 longer.
91
f22df3b @fwenzel README file.
fwenzel authored
92 License
93 -------
94 This software is licensed under the [Mozilla Tri-License][MPL]:
95
96 ***** BEGIN LICENSE BLOCK *****
97 Version: MPL 1.1/GPL 2.0/LGPL 2.1
98
99 The contents of this file are subject to the Mozilla Public License Version
100 1.1 (the "License"); you may not use this file except in compliance with
101 the License. You may obtain a copy of the License at
102 http://www.mozilla.org/MPL/
103
104 Software distributed under the License is distributed on an "AS IS" basis,
105 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
106 for the specific language governing rights and limitations under the
107 License.
108
f26df0a @fwenzel oops, Firefox Input, not Mozilla Input
fwenzel authored
109 The Original Code is Firefox Input.
f22df3b @fwenzel README file.
fwenzel authored
110
111 The Initial Developer of the Original Code is Mozilla.
112 Portions created by the Initial Developer are Copyright (C) 2010
113 the Initial Developer. All Rights Reserved.
114
115 Contributor(s):
116 Frederic Wenzel <fwenzel@mozilla.com>
117
118 Alternatively, the contents of this file may be used under the terms of
119 either the GNU General Public License Version 2 or later (the "GPL"), or
120 the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
121 in which case the provisions of the GPL or the LGPL are applicable instead
122 of those above. If you wish to allow use of your version of this file only
123 under the terms of either the GPL or the LGPL, and not to allow others to
124 use your version of this file under the terms of the MPL, indicate your
125 decision by deleting the provisions above and replace them with the notice
126 and other provisions required by the GPL or the LGPL. If you do not delete
127 the provisions above, a recipient may use your version of this file under
128 the terms of any one of the MPL, the GPL or the LGPL.
129
130 ***** END LICENSE BLOCK *****
131
132 [MPL]: http://www.mozilla.org/MPL/
Something went wrong with that request. Please try again.