📌 Git Version Control on MacOS

• This program is developed based in MacOS.

  • It also works in Windows, but the UI may break or cause unexpected errors.

• The goal of this program is to provide a simple GUI-based git repository management service.

  

  • Feature #1: File explorer

    The service provides a GUI for browsing files and directories on your computer.

    • The file browsing starts from the root directory of the computer of the most recently visited directory.
    • All files and directories included in the current directory are displayed with their icon, name, and extension.
    • A user can browse a directory by double clicking its icon.

  • Feature #2: Git repository creation

    The service supports to turn any local directory into a git repository

    • It provides a menu for a git repository creation only if a current directory in the browser is not managed by git yet.
    • Once the repository creation is requested, the service creates a new git repository for the current working directory.

  • Feature #3: Version controlling

    The service supports the version controlling of a git repository

    • Files with different status have a different mark on their icon.
    • It provides a different menu depending on the status of a selected file.
    • This program can execute the following git command
      • git init
      • git add
      • git commit
      • git mv
      • git rm
      • git rm —cached
      • git restore
      • git restore —staged

  • Feature #4: Branch management

    The service supports the branch management of a git repository

    • This program supports the following functionalities relate with branches.
      • git branch {branch_name}
      • git branch -D {branch_name}
      • git branch -m {old_name} {new_name}
      • git checkout {branch_name}
      • git merge {branch_name}

  • Feature #5: Branch merge

    The service supports to merge two branches

    • It provides a menu to merge a target branch to the current branch.
      • It provides branch list to user and asks to select one of the branches
      • It then attempts to merge the selected branches
        • If success, It provides the user with a success message
        • Otherwise, It provides the user with an error message
          • If the merge is failed due to conflict, it provides the user with unmerged paths and simply aborts the merge process

  • Feature #6: Commit history

    The service shows the commit history of a project in the form of a simplified graph

    • Each commit object in the graph includes its author name and message.
    • If a user chooses a commit object, then it provides the detailed information about the commit

  • Featire #7: Git clone from Github

    The service provides a functionality to clone a git repository from Github to local

    • When cloning public repositories, just ask a user a Github repository address.
    • When cloning private repositories, ask a user a Github repository address, ID, and access token.
      • The ID and token infomation are stored in secrets.json for the future use.

⚙️ How to execute this program

• **Python 3.9 or later must be installed**
• Depending on the version install: Tkinter
• Please run the program in zsh, not bash

📌 Follow the instructions belows if you want to execute this program

1. download or clone this repo and go to this project folder
2. run via command line pip3 install -r requirements.txt
3. python3 app.py

📍Features

🚥 Git status

• untracked

  • directory

    

  • file

    

• modified

  • directory

    

  • file

    

• staged

  • directory

    

  • file

    

• committed

  • directory

    

  • file

    

→ How does one file/directory represent if it has multiple statuses (e.g. staged & untracked, staged & modified, etc.)?

It is expressed by setting priorities in the order of untracked > modified > staged > committed.