Global Impact Study Inventory Database

Copyright (C) 2008-2012  TASCHA : Technology and Social Change Group,
University of Washington Information School : http://tascha.uw.edu/


--------
overview
--------

This is the source code of the Global Impact Study Inventory Database webapp, 
http://database.globalimpactstudy.org/

This is open-source software licensed under the GPL v. 3. For more details 
see the file named COPYING in this directory.

NOTE some changes will be required to run this code stand-alone.
At minimum the custom user authentication will have to be disabled (see "user authentication" below).


--------
platform
--------

* mysql database
* web server that supports PHP
* symfony web application framework, version 1.4 - http://symfony.com/
* dojo javascript framework (dojo, dojox, dijit), version 1.4.2 - http://dojotoolkit.org/



-------------------
distribution layout
-------------------

db directory

* SQL to generate structure of the database
* data is available separately: see online inventory database for details

webapp directory

* source code of the web appliction
* this is organized in the form of a standard symfony application



---------
deploying
---------

* unpack symfony distribution to web server's document root
* copy webapp source code over symfony distribution
* unpack dojo distribution to [deploy dir]/web/js/dojo/dojo, 
[deploy dir]/web/js/dojo/dojox, [deploy dir]/web/js/dojo/dijit



------------------
user authentiction
------------------

this webapp includes a custom authentication component to use an external
user database - users associated with the global impact study online 
publications library. This will have to be removed in order to do run the 
web application on its own. The custom authentication compoent is implemeted
via the check_password_callable callback of the sf_guard_plugin. 

