--- /dev/null +++ b/README @@ -1 +1,30 @@ +==REQUIREMENTS== +--python packages-- +Flask +pymongo +oursql +requests +lxml +sweetmaker + +--applications-- +mySQL +MongoDB +libxml +libxslt + + +==CONFIGURATION== +Copy the sampleConf.py and sampleConfig.js file to conf.py and config.js, respectively, and modify the files. + + +==INSTALL== +To install the required dependencies, use the following command when inside the top level directory of the project. +$python setup.py develop + +After the packages and dependencies have been satisfied, the application can be started by, +$python alipi.py + +==DEPLOYMENT== +Alipi is a flask application. To deploy flask applications, please see http://flask.pocoo.org/docs/deploying/#deployment --- a/README.org +++ /dev/null @@ -1,17 +1 @@ -* Alipi - Alipi is re-narration web framework. - - [[http://a11y.in]] - - [[http://alipi.us]] - -** Setup - + =$python setup.py develop= - + You will also need to install - - MongoDB - - Check http://mongodb.org for installation notes. - - mod_wsgi - - =$ sudo aptitude install libapache2-mod-wsgi= --- a/alipi/sampleConf.py +++ b/alipi/sampleConf.py @@ -1,9 +1,18 @@ #This is a samply config file. Create a file named conf.py,in this directory, and decalre the following variables there. #DO NOT EDIT THIS FILE. This file is not read for config changes -APPURL = ('http://foo/bar',) # The path which points to "alipi" directory. +APPURL = ('http://y.a11y.in',) # The path which points to "alipi" directory. JQUERYURL = ('http://foo.jquery',) #URL for jquery. -PASSWD = ('password',) -BLOGURL = ('http://something.blogspot.com',) -EMAIL = ('johnDoe@gmail.com',) -DEPLOYURL = ('http://127.0.0.1:5000/',) +JQUERYUI = ('http://y.a11y.in/apis',) #URL for loading jQuery UI theme and widgets +JQUERYCSS = ('http://y.a11y.in/apis',) #URL for loading custom jQuery CSS +PASSWD = ('password',) #Deprecated +BLOGURL = ('http://something.blogspot.com',) #Temporarily deprecated. +EMAIL = ('johnDoe@gmail.com',) #Deprecated +DEPLOYURL = ('http://y.a11y.in/app',) #URL pointing to the application +DBNAME = ('test',) #mySQL db for holding a list of language and location +DBPASSWD = ('admin',) #mySQL password +DBUSRNAME = ('sql_password',) #mySQL user with read access to the DBNAME +DBHOST = ('localhost',) +MONGODB = ('alipi',) #Name of the database in MongoDB +SWEETURL = ('http://demo.swtr.us',) #URL to a sweet store +SWEET_STORE_ADD = ("http://demo.swtr.us/add",) #The specific API endpoint for submitting sweets --- a/alipi/sampleConfig.js +++ b/alipi/sampleConfig.js @@ -1,7 +1,13 @@ //A sample configuration file for JS variables. Copy this file to "config.js" +/*config['hostname'] = "hostname of the domain from the application is served" + * config['deploy'] = "URL of where the application is deployed, same as DEPLOYURL in conf.py" + * config['root'] = "Same as APPURL from conf.py" + * config['sweet'] = "URL for the sweet store, same as SWEETURL from conf.py" + */ var config = { - 'hostname': "127.0.0.1", - 'deploy': "http://127.0.0.1:5000", - 'root': "http://localhost" + 'hostname': "y.a11y.in", + 'deploy': "http://y.a11y.in/web", + 'root': "http://y.a11y.in", + 'sweet': "http://demo.swtr.us" } --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ -Flask -GData +Flask lxml oursql pymongo +requests