HubListener

Team Name: HubListener
Team Members: Pedro Oliveira, Zed Ahmad, Piranaven Selva, Prakhar Jalan

What is HubListener?

HubListener is an analysis tool designed to provide users with relevant metrics, trends, and information regarding their GitHub projects. It aims to bring this set of organized data to the user’s attention and push them to make any improvements or corrections; as a means of project review and evaluation. The tool puts a given repository against a set of the most popular projects on GitHub, making comparisons wherever possible.

Quick Start

See Quick Start Guide

JSDoc Documentation

• See Contributor's Guide for details on how to run the JSDoc's manually.
• See https://pjmc-oliveira.github.io/HubListener/ for latest JSDoc. The JSDoc's is updated on every commit and pushed to our GitHub Pages.

Travis CI

HubListener uses Travis CI to do its automated testing and JSDoc Documentation. After every commit, Travis CI runs the automated testing and regenerates the JSDocs. The JSDocs are pushed to the gh-pages branch which is viewable via our webpage. If there are any failed tests or issues with the JSDocs an email will be sent to the developer who last committed.

Summary of Folder Structure and File Contents

Doc
Documentation for the project

• Architecture & Design
• Development Plan
• Final Presentation
• Onboarding
• Poster
• Requirements Specifications Document
• Verification & Validation Plan

ReferenceMaterial

• Research Material used as foundations for the project

src

• The main folder for HubListener source code

.travis.yml

• Used for automated testing and documentation

.gitignore

• Used by git (specifies which file(type)s to ignore when committing)

LICENSE

• License information

README.md

• This file