|
1 README FOR BROWSERSCOPE |
|
2 ----------------------- |
|
3 |
|
4 Hey there - thanks for downloading the code. This file has instructions |
|
5 for getting setup so that you can run the codebase locally. |
|
6 |
|
7 This project is built on Google App Engine using the |
|
8 Django web application framework and written in Python. |
|
9 |
|
10 To get started, you'll need to first download the App Engine SDK at: |
|
11 http://code.google.com/appengine/downloads.html |
|
12 |
|
13 For local development, just startup the server: |
|
14 ./pathto/google_appengine/dev_appserver.py --port=8080 browserscope |
|
15 |
|
16 You should then be able to access the local application at: |
|
17 http://localhost:8080/ |
|
18 |
|
19 Note: the first time you hit the homepage it may take a little |
|
20 while - that's because it's trying to read out median times for all |
|
21 of the tests from a nonexistent datastore and write to memcache. |
|
22 Just be a lil patient. |
|
23 |
|
24 You can run the unit tests at: |
|
25 http://localhost:8080/test |
|
26 |
|
27 |
|
28 CONTRIBUTING |
|
29 ------------------ |
|
30 |
|
31 Most likely you are interested in adding new tests or creating |
|
32 a new test category. If you are interested in adding tests to an existing |
|
33 "category" you may want to get in touch with the maintainer for that |
|
34 branch of the tree. We are really looking forward to receiving your |
|
35 code in patch format. Currently the category maintainers are: |
|
36 Network: Steve Souders <souders@gmail.com> |
|
37 Reflow: Lindsey Simon <elsigh@gmail.com> |
|
38 Security: Adam Barth <adam@adambarth.com> and Collin Jackson <collin@collinjackson.com> |
|
39 |
|
40 |
|
41 To create a completely new test category: |
|
42 * Copy one of the existing directories in categories/ |
|
43 * Edit your test_set.py, handlers.py |
|
44 * Add your files in templates/ and static/ |
|
45 * Update urls.py and settings.CATEGORIES |
|
46 * Follow the examples of other tests re: |
|
47 * beaconing using/testdriver_base |
|
48 * your GetScoreAndDisplayValue method |
|
49 * your GetRowScoreAndDisplayValue method |
|
50 |
|
51 References: |
|
52 * App Engine Docs - http://code.google.com/appengine/docs/python/overview.html |
|
53 * App Engine Group - http://groups.google.com/group/google-appengine |
|
54 * Python Docs - http://www.python.org/doc/ |
|
55 * Django - http://www.djangoproject.com/ |
|
56 |
|
57 |
|
58 |