tutorial-code-walkthrough.html

  
 <!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Tutorial: code-walkthrough</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Tutorial: code-walkthrough</h1>

    <section>

<header>
    

    <h2>code-walkthrough</h2>
</header>

<article>
    <h1>High-level code walkthrough</h1>
<h2>Code inventory and testing strategy</h2>
<p>The Shields codebase is divided into several parts:</p>
<ol>
<li>The frontend (about 7% of the code)
<ol>
<li><a href="https://github.com/badges/shields/tree/master/frontend"><code>frontend</code></a></li>
</ol>
</li>
<li>The badge renderer (which is available as an npm package)
<ol>
<li><a href="https://github.com/badges/shields/tree/master/badge-maker"><code>badge-maker</code></a></li>
</ol>
</li>
<li>The base service classes (about 8% of the code, and probably the most important
code in the codebase)
<ol>
<li><a href="https://github.com/badges/shields/tree/master/core/base-service"><code>core/base-service</code></a></li>
</ol>
</li>
<li>The server code and a few related odds and ends
<ol>
<li><a href="https://github.com/badges/shields/tree/master/core/server"><code>core/server</code></a></li>
</ol>
</li>
<li>Helper code for token pooling and persistence (used to avoid GitHub rate limiting)
<ol>
<li><a href="https://github.com/badges/shields/tree/master/core/token-pooling"><code>core/token-pooling</code></a></li>
</ol>
</li>
<li>Service common helper functions (about 7% of the code, and fairly important
since it’s shared across much of the service code)
<ol>
<li><code>*.js</code> in the root of <a href="https://github.com/badges/shields/tree/master/services"><code>services</code></a></li>
</ol>
</li>
<li>The services themselves (about 80% of the code)
<ol>
<li><code>*.js</code> in the folders of <a href="https://github.com/badges/shields/tree/master/services"><code>services</code></a></li>
</ol>