Quick Start

This page serves as a guide for setting up and using HubListener.

Getting HubListener

To get the latest version of HubListener, download or clone the repository at https://github.com/pjmc-oliveira/HubListener

Node.js

Download and install Node.js
Either the latest LTS version or the current version would be appropriate.

Python

Download and install the latest stable release of Python 3
The Python installer will also install pip, ensure this option remains selected. Windows users should select the 'add python to PATH' option.
Python 3 should be accessible on the terminal as python3 for OSX users and python for Windows users.
pip for python 3 should be accessible on the terminal as pip.

SQLite3

OSX users should have SQLite3 already installed on their machines.
Windows users should download the 32-bit precompiled binaries and tools to the C:\Windows\System32 directory.

GitHub API token

To use HubListener, you must have a valid GitHub personal access token. To create one, follow the instructions below:

1. Log into GitHub and visit the Personal Access Tokens page
2. Click "Generate new token"
3. Use any token description that is meaningful to you (such as HubListener)
4. Select the public_repo scope
5. Click "generate token"
6. Copy the token string to a file and save it as auth_token.txt to the HubListener src directory.

This file can now be used by HubListener to connect to open GitHub repositories and pull GitHub metrics.

First Run

1. Ensure auth_token.txt is present in the HubListener src directory
2. In your terminal of choice, move to the HubListener src directory
3. Run npm install to fetch all npm dependencies
4. Run pip install -r requirements.txt to fetch all python dependencies
5. HubListener can be run over the CLI, or launched as a web application.
   • To run HubListener on the CLI, run node app.js --url <REPO URL> --out <filename> from the HubListener src directory and follow the usage instructions.
   • To run HubListener as a web application, run npm start from the HubListener src directory and access the application through http://localhost:8080 in your web browser.