Webmaker/Code: Difference between revisions

1,042 bytes added ,  11 October 2013
no edit summary
No edit summary
No edit summary
Line 125: Line 125:
===3. Understand Webmaker Code===
===3. Understand Webmaker Code===


The Webmaker code is spread across a large number of repositories, modules, libraries, apps, and web sites.  Trying to locate the code for a particular part of Webmaker can be a challenge.  The following is a tour through our code, and who to ask for more information:
The Webmaker code is spread across a large number of repositories, modules, libraries, apps, and web sites.  Trying to locate the code for a particular part of Webmaker can be a challenge.  The following is a high level introduction to the code.
 
====Technical Overview of Webmaker====
 
Users typically begin at https://webmaker.org, and so our discussion will start there too.  The webmaker.org site has four main features, including:
 
# allowing users to access Webmaker tools, including '''Popcorn Maker''', '''Thimble''', and '''X-Ray Goggles'''.
# allowing users to search for and browse various "makes," which are objects in the '''Make API''' made with one of the Webmaker tools, or by a third-party web tool.
# allowing users to create or find Webmaker Events, using a Google Maps driven sub-application often referred to as '''Webmaker Events''' or just '''Events'''.
# allowing users to create a Webmaker (and by extension, Persona) account.
 
 


====A Tour of Webmaker Code====
====A Tour of Webmaker Code====
Line 166: Line 177:
* list of all our git repos, owners/peers
* list of all our git repos, owners/peers
* high-level diagram/description of how the pieces of Webmaker fit together
* high-level diagram/description of how the pieces of Webmaker fit together
====Webmaker Style Guide====
Anyone working on Webmaker's front-end, or otherwise altering aspects of user-facing UI/UX should be aware of the [https://wiki.mozilla.org/Webmaker/styleguide Webmaker Style Guide].  The Style Guide provides important information about Webmaker's design philosophy and branding, typography, logos, colours, thumbnails, etc.


===4. Learn the Webmaker Development Workflow===
===4. Learn the Webmaker Development Workflow===
Confirmed users
656

edits