Commit 42f8d2816c343c82d0fe91e78fbb3d834953dc52

  • avatar
  • arvind
  • Fri May 30 12:25:11 IST 2014
Fix:
    Grammar and spelling errors.
    Adding Nginx wsgi wiki link.
    Adding a section for issues.
  • Diff rendering mode:
  • inline
  • side by side

README.md

32 - [GET] /api/sweets/q?who=<username>&what=<contextname>&where=<URL> :32 - [GET] /api/sweets/q?who=<username>&what=<contextname>&where=<URL> :
33 This API is for querying sweet based on the who, what and where33 This API is for querying sweet based on the who, what and where
34 parameters.34 parameters.
35 This API do not support querying based on parameters mentioned in how,
35 This API does not support querying based on parameters mentioned in how,
36 but will be supported in future. Right now, the client can get sweets36 but will be supported in future. Right now, the client can get sweets
37 based on the above mentioned three parameters, and as the 'how' part is37 based on the above mentioned three parameters, and as the 'how' part is
38 a JSON, it is trivial to do further filtering based on parameters of38 a JSON, it is trivial to do further filtering based on parameters of
……
5454
55The swtstore application is written in Python and uses a relational database.55The swtstore application is written in Python and uses a relational database.
5656
57Hence, the dependencies of this application is Python and any relational database
57Hence, the dependencies of this application are Python and any relational database
58supported by SQLAlchemy.58supported by SQLAlchemy.
5959
60Most common RDBMS supported by SQLAlchemy are MySQL, Postgresql.60Most common RDBMS supported by SQLAlchemy are MySQL, Postgresql.
……
127 `` $ python dbsetup.py ``127 `` $ python dbsetup.py ``
128128
129**NOTE:** Please remember that all these configuration step is necessary and is129**NOTE:** Please remember that all these configuration step is necessary and is
130required wether you are running the application locally or deploying it on a
130required whether you are running the application locally or deploying it on a
131server.131server.
132132
133133
……
157See Apache WSGI configuration here:157See Apache WSGI configuration here:
158[http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIScriptAlias.html](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIScriptAlias.html)158[http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIScriptAlias.html](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIScriptAlias.html)
159159
160TODO: [insert Nginx WSGI config link]
160See Nginx WSGI configuration here:
161[http://uwsgi-docs.readthedocs.org/en/latest/WSGIquickstart.html](http://uwsgi-docs.readthedocs.org/en/latest/WSGIquickstart.html)
161162
162163
163Help / Feedback164Help / Feedback
……
177BSD Licensed.177BSD Licensed.
178178
179See LICENSE for more details.179See LICENSE for more details.
180
181
182Known Issues
183------------
184
185* Infinite loop in Persona sign-in flow. When the backend API /users/login fail
186 to connect to the Mozilla Persona APIs (connection timed out etc.) - the
187 /users/login returns a 500, and then the Persona Javascript SDK calls the
188 logout API /users/logout and then it calls the login API again; as a result
189 the entire sign-in flow falls in a infinite loop.
190
191* Automatic log out from Persona. Persona forces a user to login, again, when he
192 opens SWeeT store while being logged into Persona, through a different
193 site. Persona requires the user, every time, to explicilty say that he is
194 agreeing to share the email adress with a site that is using Persona API.