Inspiration

Whether you're looking to make open-source contributions or researching a potential technology to use for an upcoming project, it's important to know the basic metrics of the repositories you're interested in. While a user can just go to the repository on GitHub and look through all of its stats, researching repositories can be time-consuming and cut into valuable development time.

What it does

Our project simplifies the repository research process by providing users with the metrics that matter in an easily digestible format. Easily compare the stats of two repositories of interest.

How we built it

We used the following technologies to build and deploy the project:

  • Vite
  • React
  • GraphQL
  • Vercel

Challenges we ran into

In an effort to learn and implement some new technologies we hadn't used before, we began research on building out a Go API server for our backend. After spending some time looking into building a Go server and learning about the libraries and frameworks available to us, we determined that developing a backend API may not be feasible (or necessary) by the project deadline. We were able to change gears quickly and reassigned responsibilities for tasks that needed to be done to complete the project.

When we ran into hiccups regarding querying the data needed from GitHub's GraphQL API, we made the necessary adjustments to the project to ensure a demo-ready minimum viable product was ready by the deadline.

An additional feature idea we considered implementing was to generate an SVG image of the repo stats card/badge that could be added to the documentation of GitHub repositories. This stats card/badge would automatically update.

Accomplishments that we're proud of

Our biggest accomplishment in building out this project was having a demo-ready MVP by the deadline of the hackathon. All of the teammates for this project had other obligations during the span of the hackathon that cut into our work time on the project, but by communicating regularly, we were able to resolve the major issues we came across.

Another accomplishment we're proud of was being able to produce a project within a group of people who had just met for the first time during the first week of the fellowship.

What we learned

  • basic Golang
  • Go libraries and frameworks
  • Solidified understanding of React concepts
  • GitHub GraphQL API

What's next for Repo Diff

An additional feature idea we considered implementing was to generate an SVG image of the repo stats card/badge that could be added to the documentation of GitHub repositories. This stats card/badge would automatically update.

Built With

Share this project:

Updates