Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.15 KB

README.md

File metadata and controls

67 lines (45 loc) · 1.15 KB
Raw

Mini Git GUI

A minimalistic git client for mobile.

Quick Start

Prerequisites

Have a terminal installed.

  • Android: Termux
  • iOS: (Coming Soon)

Have Node.js installed.

Usage

Run the following command in your project root.

npx mini-git-gui

Go to the link shown (eg. http://localhost:3000) on a browser to access the git GUI.

Notes

If you do not want a global install of mini-git-gui, you can choose to install it locally in your project folder.

# Run this command if you do not have a package.json
npm init -y

# Installs mini-git-gui as a dev dependency
npm i -D mini-git-gui

# Run mini-git-gui
npx mini-git-gui

Features

  • Commit Graph (Experimental)
  • Stage/Unstage Files
  • Commit Files
  • Discard Files
  • View File Changes

Tech Stack

  • Frontend
    • React
    • Vite
    • Tailwind
    • Shadcn/ui
    • Tanstack Query
    • Jotai
  • Backend
    • Express
    • TRPC

For Developers

Commands and Contributing Guide: CONTRIBUTING.md