Author: Gary  Roberts
Date: 11 May 2009

Tall Street Site search is a customizable search engine that you provide a list
of links to and it'll index them.

Install Instructions:

This app is intended to be run on Google AppEngine http://code.google.com/appengine/

To deploy:

1. edit the file app.yaml

Change the line:

application: gaesites

to the name of the application you wish to deploy to. (you need to create the application at http://appengine.google.com/ first)

application: <<appname>

2. run the following command:

python manage.py update

3. visit the url in your browser:

http://<<appname>>.appspot.com/

Test Local Instructions:

1. run the follow command:

python manage.py runserver

2. visit the following url in your browser:

http://localhost:8000/


This application uses the Django Framework (http://www.djangoproject.com/) and uses app engine patch
( http://code.google.com/p/app-engine-patch/ ) to allow it to run in the appengine environment


File Structure
--------

common/ -- Appengine Patch and Django files, shouldn't need any modifications in here

_generated_media/ -- Folder generated by app engine patch for deploying onto app engine

media/ -- images and CSS files to modify for the look and feel of the site

templates/ -- these are the sitewide templates to modify the look and feel of the site (e.g. how the header and the footer of the site should look). The main one is base.html the others are just how error pages should look.

search/ -- this is the search application that handels search 

search/templates -- These are the templates where the way to display listing pages, and detail pages, the home page and the right side bar (topitems.html) are defined

search/views.py -- this is where the business logic is defined

search/models.py -- this is where the database model for the application is defined

search/urls.py -- this is where the urls structure is defined.

settings.py -- these are important application settings. In particular you need to define TWITTERAUTH_KEY, and TWITTERAUTH_SECRET


Admin Site
-------
To add links to the index you need to use the admin site. To do this visit

http://gaesites.appspot.com/login 

Then you can access the admin site at

http://gaesites.appspot.com/admin