Commit 4dde4134e0bbbed8047373421b9de5b6a5a0980f

Adding README and requirements.txt.


		1	==REQUIREMENTS==
		2	--python packages--
		3	Flask
		4	pymongo
		5	oursql
		6	requests
		7	lxml
		8	sweetmaker
		9
		10	--applications--
		11	mySQL
		12	MongoDB
		13	libxml
		14	libxslt
		15
		16
		17	==CONFIGURATION==
		18	Copy the sampleConf.py and sampleConfig.js file to conf.py and config.js, respectively, and modify the files.
		19
		20
		21	==INSTALL==
		22	To install the required dependencies, use the following command when inside the top level directory of the project.
		23	$python setup.py develop
		24
		25	After the packages and dependencies have been satisfied, the application can be started by,
		26	$python alipi.py
		27
		28	==DEPLOYMENT==
		29	Alipi is a flask application. To deploy flask applications, please see http://flask.pocoo.org/docs/deploying/#deployment


	1		* Alipi
	2		Alipi is re-narration web framework.
	3
	4		[[http://a11y.in]]
	5
	6		[[http://alipi.us]]
	7
	8		** Setup
	9		+ =$python setup.py develop=
	10		+ You will also need to install
	11		- MongoDB
	12
	13		Check http://mongodb.org for installation notes.
	14		- mod_wsgi
	15
	16		=$ sudo aptitude install libapache2-mod-wsgi=


1	1	#This is a samply config file. Create a file named conf.py,in this directory, and decalre the following variables there.
2	2	#DO NOT EDIT THIS FILE. This file is not read for config changes
3		APPURL = ('http://foo/bar',) # The path which points to "alipi" directory.
	3	APPURL = ('http://y.a11y.in',) # The path which points to "alipi" directory.
4	4	JQUERYURL = ('http://foo.jquery',) #URL for jquery.
5		PASSWD = ('password',)
6		BLOGURL = ('http://something.blogspot.com',)
7		EMAIL = ('johnDoe@gmail.com',)
8		DEPLOYURL = ('http://127.0.0.1:5000/',)
	5	JQUERYUI = ('http://y.a11y.in/apis',) #URL for loading jQuery UI theme and widgets
	6	JQUERYCSS = ('http://y.a11y.in/apis',) #URL for loading custom jQuery CSS
	7	PASSWD = ('password',) #Deprecated
	8	BLOGURL = ('http://something.blogspot.com',) #Temporarily deprecated.
	9	EMAIL = ('johnDoe@gmail.com',) #Deprecated
	10	DEPLOYURL = ('http://y.a11y.in/app',) #URL pointing to the application
	11	DBNAME = ('test',) #mySQL db for holding a list of language and location
	12	DBPASSWD = ('admin',) #mySQL password
	13	DBUSRNAME = ('sql_password',) #mySQL user with read access to the DBNAME
	14	DBHOST = ('localhost',)
	15	MONGODB = ('alipi',) #Name of the database in MongoDB
	16	SWEETURL = ('http://demo.swtr.us',) #URL to a sweet store
	17	SWEET_STORE_ADD = ("http://demo.swtr.us/add",) #The specific API endpoint for submitting sweets


1	1	//A sample configuration file for JS variables. Copy this file to "config.js"
	2	/*config['hostname'] = "hostname of the domain from the application is served"
	3	* config['deploy'] = "URL of where the application is deployed, same as DEPLOYURL in conf.py"
	4	* config['root'] = "Same as APPURL from conf.py"
	5	* config['sweet'] = "URL for the sweet store, same as SWEETURL from conf.py"
	6	*/
2	7	var config = {
3		'hostname': "127.0.0.1",
4		'deploy': "http://127.0.0.1:5000",
5		'root': "http://localhost"
	8	'hostname': "y.a11y.in",
	9	'deploy': "http://y.a11y.in/web",
	10	'root': "http://y.a11y.in",
	11	'sweet': "http://demo.swtr.us"
6	12	}