Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 102 lines (70 sloc) 3.407 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
32 ### Django
6e6fe4c @fwenzel freeing product details from the claws of the reporter app.
fwenzel authored
33 To initialize the database, run:
34
35 ./manage.py syncdb
36
37 and to fetch the initial product details data, run:
38
39 ./manage.py update_product_details
40
7ab592a @fwenzel half-done search page. Need: aggregates, narrowing options.
fwenzel authored
41 Finally, to initialize the [search index][Haystack], run:
42
43 ./manage.py rebuild_index
44
f22df3b @fwenzel README file.
fwenzel authored
45 The Internet has plenty of of documentation on setting up a Django application
46 with any web server. If you need a wsgi entry point, you can find one in
47 ``wsgi/reporter.wsgi``.
48
b093c3b @fwenzel added missing link
fwenzel authored
49 [Haystack]: http://haystacksearch.org/
50
7ab592a @fwenzel half-done search page. Need: aggregates, narrowing options.
fwenzel authored
51 ### Cron jobs
52 There are two jobs you want to run periodically:
53
54 ./manage.py update_product_details # Mozilla Product Details update
55 ./manage.py update_index # update search index
56
57 The frequency is up to you, but you probably want to run the search index
58 updates relatively frequently, while the product details can wait a little
59 longer.
60
f22df3b @fwenzel README file.
fwenzel authored
61 License
62 -------
63 This software is licensed under the [Mozilla Tri-License][MPL]:
64
65 ***** BEGIN LICENSE BLOCK *****
66 Version: MPL 1.1/GPL 2.0/LGPL 2.1
67
68 The contents of this file are subject to the Mozilla Public License Version
69 1.1 (the "License"); you may not use this file except in compliance with
70 the License. You may obtain a copy of the License at
71 http://www.mozilla.org/MPL/
72
73 Software distributed under the License is distributed on an "AS IS" basis,
74 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
75 for the specific language governing rights and limitations under the
76 License.
77
f26df0a @fwenzel oops, Firefox Input, not Mozilla Input
fwenzel authored
78 The Original Code is Firefox Input.
f22df3b @fwenzel README file.
fwenzel authored
79
80 The Initial Developer of the Original Code is Mozilla.
81 Portions created by the Initial Developer are Copyright (C) 2010
82 the Initial Developer. All Rights Reserved.
83
84 Contributor(s):
85 Frederic Wenzel <fwenzel@mozilla.com>
86
87 Alternatively, the contents of this file may be used under the terms of
88 either the GNU General Public License Version 2 or later (the "GPL"), or
89 the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
90 in which case the provisions of the GPL or the LGPL are applicable instead
91 of those above. If you wish to allow use of your version of this file only
92 under the terms of either the GPL or the LGPL, and not to allow others to
93 use your version of this file under the terms of the MPL, indicate your
94 decision by deleting the provisions above and replace them with the notice
95 and other provisions required by the GPL or the LGPL. If you do not delete
96 the provisions above, a recipient may use your version of this file under
97 the terms of any one of the MPL, the GPL or the LGPL.
98
99 ***** END LICENSE BLOCK *****
100
101 [MPL]: http://www.mozilla.org/MPL/
Something went wrong with that request. Please try again.