Code Monkey home page Code Monkey logo

calamaricrew's Introduction

Maintainability Test Coverage

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!

calamaricrew's People

Contributors

azirly avatar vermar0187 avatar lironbc avatar ctakayama avatar andrewkassab avatar kenlhua avatar kwokmingleung avatar helenshu avatar bonnieguan avatar javalosm avatar

Stargazers

Nick Zhu avatar  avatar akew794181 avatar  avatar  avatar  avatar

Watchers

raysaka avatar James Cloos avatar  avatar  avatar  avatar

calamaricrew's Issues

UI Gallery of accessories

There should be a way to see through the extension the accessories you have earned and be able to select through them to customize the velocity raptor

Display Name

Display the name of the dinosaur clearly and effectively

Name Filter

Pass the name string through a library called DOMPurify to make sure it is a security safe name

Project Documentation

Go through current documentation, see if you understand it.
Go through current code and see how much of it you can understand with the given documentation.
If there isn't any documentation for it, make a guess and shoot it at the right person.
If you guessed wrong or it took way too much time to think of the right guess then write up the documentation.
Write up a doc outlining the code structure as well. What files go where, etc. If that doesn't exist yet.

Oauth rework

Refactor github oauth to no longer require a backend.

Add Script to Read Code Coverage Report

Istanbul (Code Coverage Tool) creates a coverage report file (.json) in /coverage. We need to write as script to auto-read how much code was tested and have a threshold (70%?) if code was tested enough.

Display Raptor Running With User's Velocity

  • (Name: Get user's velocity , Estimate: 8 hrs)
  • Subtask: Ask user for their initial repo (can be changed later)
  • Subtask: Get all milestones associated with that repo
  • Subtask: Filter to get the milestone with the soonest deadline
  • Subtask: Get all issues assigned to user
  • Subtask: Calculate velocity by dividing number open / total number

Ask and Set Sprint Period

Create frontend UI to ask team manager to set the length of their sprint at the beginning of the sprint

Move to Main Page

Once done with initial settings, move on to main page with raptor

Github Task List

As a developer I want to have my task list in the extension so that I don't have to go all the way to GitHub to see it (L, Total = 16 hrs)

  • (Name: Get Tasks in Current Sprint, Description: Use github API to pull all tasks from your selected repo, filter your tasks that are allocated to this sprint, display them. Estimate: 8 hrs)
  • (Name: Update Tasks, Description: Repull data on response to tasks being changed so that tasks menu always shows the current tasks needed to be completed. Estimate: 5)
  • (Name: Update velocity, Description: Calculate current velocity based off of how many tasks are left. Estimate: 3)

App-SQL Connection

Connecting to the SQL database with the app and setting up the REST API

Closure of Github issues

In the task list, we want to be able to checkoff the task with a confirm button, which will close the regarding Github issue, and trigger a new speed.

Name Storage

Store the name of the Velociraptor in local storage

SQL Database Definition

Define the columns of the SQL database for external storage including thinking up of the schematic

Add Github Repo

On the extension, show a list of the user's repositories, ask them to select one + confirm button

Display of github issues

Currently on DEV-MASTER, it will only show a single issue under the My Github Issues list on the home page.

Screen Shot 2020-05-26 at 7 20 45 PM

Screen Shot 2020-05-26 at 7 20 50 PM

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.