Skip to content

A web App that generates a storyline based on the commit history of a github repo

Notifications You must be signed in to change notification settings

hk-vk/commitstorygen

Repository files navigation

COMMIT STORY GEN🎯

Basic Details

Team Name: SABHASH

Team Members

  • Team Lead: Harikrishnan V K - [Government Engineering College Idukki]
  • Member 2: Savitha G S - [Government Engineering College Idukki]
  • Member 3: Abhirami K S - [Government Engineering College Idukki]

Project Description

CommitStoryGen transforms commit history into a narrative, providing a unique perspective on development journeys.

The Problem (that doesn't exist)

Tracking development progress is often informative, but what if you could turn it into a story worth telling?

The Solution (that nobody asked for)

CommitStoryGen uses commit messages to generate a project storyline, giving every developer’s journey a bit of flair and storytelling magic.

Technical Details

Technologies/Components Used

For Software:

  • Javascript, React
  • Next JS
  • shadcn
  • Tools Used:-VS Code, OpenAI API, Github API

CommitStoryGen

CommitStoryGen transforms your development journey into a story by analyzing your project's commit history. Designed for developers and teams, it highlights progress, key milestones, and significant changes. This web app extracts commit messages from your repository, generating a cohesive narrative that aids retrospectives, project insights, and team collaboration. With a clean, interactive UI , CommitStoryGen brings your code's evolution to life. Built on Next.js, it offers a seamless experience to review, reflect, and share your project’s story—one commit at a time.

Installation

To install the necessary packages, run the following command:

npm install

To Run the Application

npm run dev

Environments Variables

Add the necessary environment variables in the .env.local file

GITHUB_TOKEN=
GOOGLE_AI_KEY=

Project Documentation

Screenshots

Homepage Screenshot
This screenshot showcases the homepage of CommitStoryGen.

Commit Analysis Page
This screenshot highlights the commit analysis feature.

Story Generation
This screenshot shows the generated story based on commit history.


Project Demo

Video

This video demonstrates the full functionality of CommitStoryGen, from commit analysis to story output.

Screen.Recording.2024-11-02.001159.mp4

Additional Demos (Add any extra demo materials/links if applicable)

Team Contributions

  • Harikrishnan V K: Project lead, backend setup, and core commit analysis development.
  • Savitha G S: Frontend development, UI/UX design, and component styling.
  • Abhirami K S: Story generation logic, animations, and documentation. Made with ❤️ at TinkerHub Useless Projects

About

A web App that generates a storyline based on the commit history of a github repo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •