/VelocityRaptor

A Chrome Extension that rewards users for completing tasks in their repos | developed for CSE 112 at UCSD

Primary LanguageJavaScript

Automation Pipeline Selenium Java CI

Velocity Raptor Chrome Extension

User Guide

For a more detailed guide, click here: https://3.basecamp.com/4479372/buckets/16663023/documents/2738615926

Welcome to Velocity Raptor! The extension that allows you to track your sprint velocity with a cool looking customizable raptor. Your raptor will run faster as you finish your GitHub issues!

Github Authentication

Upon opening the extension, you will be taken to a home screen with a link to login to GitHub. Click the "Link to GitHub" button, and you will be directed to a page asking you to input your GitHub credentials. After doing so, it will ask you for permission to access your repositories. Once you have given permission, authentication is complete!

Setting Up

On the first usage of the extension, you will be asked to name your raptor. Note that foul language is not permitted.

After naming your raptor, you will be prompted to select a repository. If you accidentally click away from the extension, you will be presented with the main screen of the extension when you return to it. You can add or change repositories by clicking the settings button, and then GitHub Repo, where you will find another list of your repositories.

In order for issues to appear on the main screen, the repo you are synced to must have issues assigned to you that are also connected to an ongoing milestone.

In the Settings tab, under "My VelocityRaptor", you can customize your velocityraptor with the given accessories. This customization will be reflected on the velocityraptor on the main screen.

Resetting

To reset the extension, go to Settings->General, and click on the "Reset VelocityRaptor" button. There will be a surprise waiting for you!

Developer Guide

Getting started

Documentation

Accessing the Chrome Extension

  • Open up Google Chrome, and navigate to chrome://extensions/

  • On the top-left corner, click "Load Unpacked".

  • When prompted, select the directory of the cloned repository containing the manifest.json file.

  • Now, a raptor icon should appear on the top right corner.

  • Click the icon to open the extension!