Skip to content

brainless/gitplay

Repository files navigation

Welcome to gitplay!

gitplay

Please note: this product is in very early stage of development and is not really usable yet!

gitplay is a desktop application that you can use to understand the evolution of your software (which uses git for version control)

gitplay browsing the history of the Django project

Who is this for?

If you are a software developer, project manager (for software companies) or are interested in learning about software development, then gitplay is for you.

How does it work?

The git repository of any matured software has hundreds or thousands of chunks of history which capture the evolution of that software. Take Django for example, which is a web framework in the Python programming language. Using gitplay, you can deep dive into this rich history of the software, which spans more than 30,000 commits for over a decade, involving contributions from hundreds of individuals across the world.

Git stores this history of development in small chunks called commits. Commits are a like a snapshot that a developer created of the state of the software at a certain point in time. Commits usually have a comment stating what work was done and a snapshot of the entire file system of that software at the time of the commit. gitplay shows this rich data in a way similar to watching a video - commit by commit. It shows the folders/files structure as they have evolved over time.

What can I use it for?

If you have a software project version controlled with git (either open source or not) you can use gitplay to inspect its evolution. It is intended to be a powerful learning tool for software developers in general or team members in enterprises who have recently joined a project.

Rough idea of upcoming features

  • Show hot spots across the entire file structure in the whole timeline
  • See how any file(s) has progressed across time
  • Show contributions by time (like in a calendar), overall and by developer
  • Search identifiers (class/function names) across the entire history and see their changes/refactors
  • Record/play videos describing the history of a repository with anotations that open different commits/files in gitplay for users to easily follow
  • Store text anotations explaning the history to help onboard developers to new projects
  • Integrate with project management software to overlay tickets with correspond to pull/merge requests (enterprise)

How can I try it out?

Please note: this product is in very early stage of development and is not really usable yet!

  • Make sure you have npm (Node.js) and Rust installed
  • (Fork, if you want) Clone this repository, git clone git@github.com:brainless/gitplay.git
  • cd gitplay
  • Run npm install
  • Run npm run tauri dev

Thank you for checking out this product and I hope you will follow our progress.

About

Learn how a software project (using git) evolved over time from its commit log. Its like YouTube for a git project. Desktop app built with Rust and SolidJS

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published