Git Polish

Inspiration

It's internship hunting season, and our team is going through the monotonous task of updating our GitHub repositories. We thought it would be nice to have a tool that efficiently cleans and updates our repositories to make them look nice for the public.

What it does

Git Polish allows a user to clean up their repositories by creating a new README, description, and a list of changes that could be made to make the repository better. The project is both a web application and a Command-Line Interface (CLI) tool.

How we built it

The app was built with NextJS and leverages Google Gemini & Firebase. It uses OAuth to get user data from GitHub and Google Gemini API to create changes for the repository.

Challenges we ran into

The first challenge we ran into was getting a user's GitHub data with OAuth; it's tricky to configure. Additionally, it was difficult to find a way to parse the repository's files and expensive to implement the features on Google Gemini.

Accomplishments that we're proud of

We're proud of the features that we implemented in a short amount of time. Creating a new README was the first feature we made, and it took a lot of planning, configuring, and execution to be able to parse the files of the repo. Once we got it to work, we had a blueprint for the other features. We were also pleased to have the features operate in a CLI tool, which provides an extra level of convenience for users.

What we learned

In the web app, we learned how to use Google Cloud functions to carry out tasks that are expensive for the app. In the CLI tool, we learned how to implement a client-side tool without using a browser. The team had to learn to implement OAuth to get the user data for both projects.

What's next for Git Polish

We want to create more features to go along with the ones we developed. If we had more time, we would have implemented more features, including a git branch diagram, GitHub profile suggestions, etc.