Inspiration

Trying to utilize and understand GitHub repositories can take time especially when the documentation is outdated and missing key pieces of information.

What it does

This is where Explainify comes in. Explainify takes in a public GitHub repository link and gives you documentation of every file in the repository. It catches small details so you struggle less when implementing the repository.

How we built it

The structure consisted of: Front-end/Languages: Html, css, and javascript Back-end/Languages: Flask, python Useful api's: gpt4all

Challenges we ran into

One challenge we ran into is integrating a local machine learning model into our project. Another challenge we ran into was integrating the front-end with the back-end since they were on seperate computers.

Accomplishments that we're proud of

The biggest accomplishment we were proud of was finishing the project. This project does not only help us but can help many others when it comes to understanding GitHub repositories in a small amoung of time.

What we learned

The main lesson we learned was planning, strategizing, and communicating with each other to complete a project in a day.

What's next for Explainify

The next major hurdle would be hosting our project on a website so that anyone could use our tool to better understand GitHub repositories.

Built With

Share this project:

Updates