Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document code architecture #456

Closed
calexity opened this issue Dec 5, 2014 · 4 comments
Closed

Document code architecture #456

calexity opened this issue Dec 5, 2014 · 4 comments

Comments

@calexity
Copy link
Contributor

calexity commented Dec 5, 2014

@miketaylr to document the code architecture per our retro (https://github.com/webcompat/webcompat.com/wiki/Retro-from-December-2014-work-week/)

@miketaylr
Copy link
Member

webcompat.com is a hybrid Flask/BackboneJS web app.
Flask powers the JSON API (which is a proxy of GitHub's Issues and Search API) and handles traditional MVC stuff. The view, however, is just an html page which contains the bootstrap JS for the Backbone app, and the CSS.

to document: how the form stuff works, how the API proxying happens, how we enable anonymous stuff, how our backbone apps are structured, grunt.

@miketaylr
Copy link
Member

I'm going to move this into the Backlog. It would be nice to have™, but not something that exists in every open source project, and I think my time would be better spent on other issues.

If someone wants to ask questions and contribute these kinds of docs I'd be happy to help.

@miketaylr miketaylr removed their assignment Oct 2, 2015
@miketaylr
Copy link
Member

Note: @karlcow wants to make a graph of the model of how Flask communicates with GitHub. @karlcow can you file an issue? Let's do that this week.

@karlcow
Copy link
Member

karlcow commented Aug 2, 2017

Note: @karlcow wants to make a graph of the model of how Flask communicates with GitHub. @karlcow can you file an issue? Let's do that this week.

paper trail with regards to the last comment
#1640 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants