michael@0: README FOR BROWSERSCOPE
michael@0: -----------------------
michael@0: 
michael@0: Hey there - thanks for downloading the code. This file has instructions
michael@0: for getting setup so that you can run the codebase locally.
michael@0: 
michael@0: This project is built on Google App Engine using the
michael@0: Django web application framework and written in Python.
michael@0: 
michael@0: To get started, you'll need to first download the App Engine SDK at:
michael@0: http://code.google.com/appengine/downloads.html
michael@0: 
michael@0: For local development, just startup the server:
michael@0: ./pathto/google_appengine/dev_appserver.py --port=8080 browserscope
michael@0: 
michael@0: You should then be able to access the local application at:
michael@0: http://localhost:8080/
michael@0: 
michael@0: Note: the first time you hit the homepage it may take a little
michael@0: while - that's because it's trying to read out median times for all
michael@0: of the tests from a nonexistent datastore and write to memcache.
michael@0: Just be a lil patient.
michael@0: 
michael@0: You can run the unit tests at:
michael@0:   http://localhost:8080/test
michael@0: 
michael@0: 
michael@0: CONTRIBUTING
michael@0: ------------------
michael@0: 
michael@0: Most likely you are interested in adding new tests or creating
michael@0: a new test category. If you are interested in adding tests to an existing
michael@0: "category" you may want to get in touch with the maintainer for that
michael@0: branch of the tree. We are really looking forward to receiving your
michael@0: code in patch format. Currently the category maintainers are:
michael@0: Network: Steve Souders <souders@gmail.com>
michael@0: Reflow: Lindsey Simon <elsigh@gmail.com>
michael@0: Security: Adam Barth <adam@adambarth.com> and Collin Jackson <collin@collinjackson.com>
michael@0: 
michael@0: 
michael@0: To create a completely new test category:
michael@0:   * Copy one of the existing directories in categories/
michael@0:   * Edit your test_set.py, handlers.py
michael@0:   * Add your files in templates/ and static/
michael@0:   * Update urls.py and settings.CATEGORIES
michael@0:   * Follow the examples of other tests re:
michael@0:       * beaconing using/testdriver_base
michael@0:       * your GetScoreAndDisplayValue method
michael@0:       * your GetRowScoreAndDisplayValue method
michael@0: 
michael@0: References:
michael@0:   * App Engine Docs - http://code.google.com/appengine/docs/python/overview.html
michael@0:   * App Engine Group - http://groups.google.com/group/google-appengine
michael@0:   * Python Docs - http://www.python.org/doc/
michael@0:   * Django - http://www.djangoproject.com/
michael@0: 
michael@0: 
michael@0: