GitScribe

Log in with GitHub
Home page
Loading
Generated messages
The web interface in dark mode
Future web interface

Our Team: We have four term 1 CST students and one term 2 FSWD student. We made a webpage and a CLI

Inspiration

We take a lot of time to edit and create commit messages, so we wanted to have a way to create them quickly and have them be formatted correctly.

What it does

The web system automatically generates commit messages based on the old and new versions of a file. Users can customize the number of generated commit messages and select the most appropriate one to submit.

How we built it

Using Figma to design wireflow and interface
Front-end with Vite + React + CharkaUI components
Back-end functionality with Python (using argparse library)
Connected frontend and backend using FastAPI
Using Redis to store cache data
Deployed with Vercel

Challenges we ran into

We had to learn how to use many different libraries, meaning we had to do a lot of research before we could start coding. Learning how to fix git conflicts when merging to main. Learning how to deploy our project. Learning how to make a CLI using argparse

Accomplishments that we're proud of

We were able to deploy our project and learn a lot about new libraries. Working with a great team of passionate developers.

What we learned

How to use FastAPI to connect the frontend to the backend. How to use a Redis cloud server for cache data. How to use ChakraUI components. How to use argparse. How to deploy with Vercel.

What's next for GitScribe

Using the GitHub API to access your repos in the backend so you don't have to upload the old file.
A more user-intuitive interface with access to their GitHub repositories
An option for user to enter the text of their files instead of uploading the files
Local repository access
Display the changes in code on the web interface
Expand backend network usage limits
Expand backend model usage limits