Commit 42f8d2816c343c82d0fe91e78fbb3d834953dc52
- Diff rendering mode:
- inline
- side by side
README.md
(20 / 4)
  | |||
32 | 32 | - [GET] /api/sweets/q?who=<username>&what=<contextname>&where=<URL> : | |
33 | 33 | This API is for querying sweet based on the who, what and where | |
34 | 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 | 36 | but will be supported in future. Right now, the client can get sweets | |
37 | 37 | based on the above mentioned three parameters, and as the 'how' part is | |
38 | 38 | a JSON, it is trivial to do further filtering based on parameters of | |
… | … | ||
54 | 54 | ||
55 | 55 | The swtstore application is written in Python and uses a relational database. | |
56 | 56 | ||
57 | Hence, the dependencies of this application is Python and any relational database | ||
57 | Hence, the dependencies of this application are Python and any relational database | ||
58 | 58 | supported by SQLAlchemy. | |
59 | 59 | ||
60 | 60 | Most common RDBMS supported by SQLAlchemy are MySQL, Postgresql. | |
… | … | ||
127 | 127 | `` $ python dbsetup.py `` | |
128 | 128 | ||
129 | 129 | **NOTE:** Please remember that all these configuration step is necessary and is | |
130 | required wether you are running the application locally or deploying it on a | ||
130 | required whether you are running the application locally or deploying it on a | ||
131 | 131 | server. | |
132 | 132 | ||
133 | 133 | ||
… | … | ||
157 | 157 | See Apache WSGI configuration here: | |
158 | 158 | [http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIScriptAlias.html](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIScriptAlias.html) | |
159 | 159 | ||
160 | TODO: [insert Nginx WSGI config link] | ||
160 | See Nginx WSGI configuration here: | ||
161 | [http://uwsgi-docs.readthedocs.org/en/latest/WSGIquickstart.html](http://uwsgi-docs.readthedocs.org/en/latest/WSGIquickstart.html) | ||
161 | 162 | ||
162 | 163 | ||
163 | 164 | Help / Feedback | |
… | … | ||
177 | 177 | BSD Licensed. | |
178 | 178 | ||
179 | 179 | See LICENSE for more details. | |
180 | |||
181 | |||
182 | Known 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. |