Giter Club home page Giter Club logo

gitstatus's Introduction

GitStatus - A Simple Repository Feed Widget

I was surpised that this didn't already exist, but eh, whatever.

This is a widget that provides a feed of recent commits on a repository using the Github API. It's completely client-side, so it won't work on private repositories, but that's a small price to pay.

The one thing to note about this widget is that it technically has to make two requests to GitHub to get all the information it needs. This is due to how the GitHub API works; it's less than ideal, but overall not too bad.

Example usage is as follows:

<div id="gitstatus_16258"></div>
<script type="text/javascript" src=""></script>
<script type="text/javascript">
	new GitStatus({
		id: "gitstatus_16258",
		github_username: "ryanmcgrath",
		github_repository: "pygengo",
		no_of_commits: 5,
		//disable_all_styles: true
	}).show();
</script>

Uncommenting the "disable_all_styles" option will do exactly that - no default styling will be applied and you can then style the widget to your needs from the ground up.

Questions, Comments, Praise, etc?

This was built in the space of... 2 hours, so it's not perfect. It's totally open source, though, so feel free to hack/fork/do whatever with it.

I'm available on Twitter as @ryanmcgrath, or via email at ryan [at] venodesigns (.) net. Hit me up!

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.