Code Monkey home page Code Monkey logo

githubsurvivor's Introduction

GitHub Survivor

GitHub Survivor is a simple bug dashboard that shows an overview of bugs in a GitHub-hosted repo. We use it at 99designs to keep an eye on the bug count and remind ourselves to close bugs.

Screenshot

Overview

It's easy to forget about bugs when you're knee-deep in feature development. This dashboard is a good way to keep bugs on people's minds, and to show at-a-glance information about the current bug situation.

GitHub Survivor scrapes your bug data using the GitHub API and stores it in your local Mongo DB for subsequent querying. It shows, at a glance:

  • Top/bottom bug closers for the current reporting period (week, month or sprint)
  • Current open bug count
  • Net difference in open bugs since the last reporting period
  • Charts (yay!):
    • Number of bugs opened/closed for the last 12 reporting periods
    • Number of open bugs over the last 12 reporting periods

There are bug trackers that provide this kind of data, but we wanted something fun that integrates with our existing bug tracking solution. (GitHub issues are pretty rudimentary, but they integrate nicely with pull requests, commits, etc.)

Setup

Requirements:

  • Python >= 2.7
  • virtualenv
  • MongoDB
  • lessc
  • Make

This command might satisfy the above dependencies on Ubuntu:

$ sudo apt-get install python2.7 python-virtualenv mongodb lessc make

Installation

$ git clone https://github.com/99designs/githubsurvivor.git /path/to/survivor
$ cd /path/to/survivor
$ bin/setup
$ $EDITOR config.py

Initial data import

$ bin/runtask sync

You'll probably want to run this periodically, e.g. in an hourly cron job.

Run

$ bin/serve

Development notes

Stylesheets are LESS files. Run make css to regenerate CSS from LESS sources.

License

MIT; see LICENSE

githubsurvivor's People

Contributors

asm89 avatar harto avatar samkeen avatar

Watchers

 avatar

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.