https://sourceforge.net/p/daltoncorp-gl02/wiki/Developer%2520guide/Recent changes to Developer guideenFri, 11 Jan 2019 16:42:13 -0000https://sourceforge.net/p/daltoncorp-gl02/wiki/Developer%2520guide/<div class="markdown_content"><h1 id="developer-guide">Developer Guide</h1> <p>This developer guide refers to the <a class="" href="https://sourceforge.net/p/daltoncorp-gl02">TIGER</a> program, developed by the <strong>DaltonCorp</strong> team.</p> <p>This document explains how the software structure of TIGER is and suggest some guidelines in case you want to maintain or improve it.</p> <h2 id="software-usages">Software usages</h2> <p>TIGER will get Tweets from a local or directly from Twitter, and then extract their contents in order to display metric data in different charts.</p> <p>The usages are more deeply defined in the End User Guide. Check it out whether you want to learn more about how to use TIGER.</p> <h2 id="software-structure">Software structure</h2> <p>All the functions of TIGER are splitted in different components, which makes upgradability better. Here is the list of all of them, including the external Node modules from other editors.</p> <table> <thead> <tr> <th>Component</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>tiger</td> <td>Main component of the program and interface (console only) with the end user. It processes all the commands, then send and receive data with the other components</td> </tr> <tr> <td>config</td> <td>Contains configuration strings for getting data from Twitter's API</td> </tr> <tr> <td>Parseur</td> <td>Parent class for each Parseur</td> </tr> <tr> <td>ParseurAPITweeter</td> <td>(Inherits from <em>Parseur</em>) Get tweets using Twitter's API, then parse data of each tweet, and store all of them into a list</td> </tr> <tr> <td>ParseurCSV</td> <td>(Inherits from <em>Parseur</em>) Same idea as the previous one, but tweets are imported and parsed from a local CSV</td> </tr> <tr> <td>DocGenerator</td> <td>Goes through a specified TweetList and can extract data like top hashtag, or from a search, then data are formatted into a DOCX file which is finally exported on the hard drive</td> </tr> <tr> <td>GraphGenerator</td> <td>Same idea as the previous one but analyzes data and use <em>VegaLite</em> to export charts into a SVG file</td> </tr> <tr> <td>Tweet</td> <td>Structured type to store Tweet's data</td> </tr> <tr> <td>TweetList</td> <td>List of Tweets. Provide also some methods to find out the number of tweets for a specific time interval, the top retweet...</td> </tr> </tbody> </table> <table> <thead> <tr> <th>Node modules</th> <th>Short description</th> </tr> </thead> <tbody> <tr> <td>async</td> <td>Provides patterns to work with asynchronous code</td> </tr> <tr> <td>caporal</td> <td>Full-featured framework to create console applications</td> </tr> <tr> <td>colors</td> <td>Get colors in the Node.js console</td> </tr> <tr> <td>docx</td> <td>Generate .docx files</td> </tr> <tr> <td>fast-csv</td> <td>CSV parser and writer</td> </tr> <tr> <td>inquirer</td> <td>Provides common interactive command line interfaces</td> </tr> <tr> <td>moment</td> <td>Parse, validate, manipulate, and display dates</td> </tr> <tr> <td>nodeunit</td> <td>Easy unit testing</td> </tr> <tr> <td>opencage-api-client</td> <td>OpenCage provides tools to convert coordinates to and from places</td> </tr> <tr> <td>promised-twit</td> <td>Provides convenient functions to access Twitter's API (Twit)</td> </tr> <tr> <td>vega</td> <td>Vega is a visualization grammar, a declaration format for creating, saving, and sharing interactive visualization designs.</td> </tr> <tr> <td>vega-lite</td> <td>This is a concise high-level language for Vega</td> </tr> </tbody> </table></div>Maxime MarmontFri, 11 Jan 2019 16:42:13 -0000https://sourceforge.net91d5b5fb0778a0cec7a898e809bf9e66c7b0373e