Skip to content

sporkle-app/sporkle

Repository files navigation

Sporkle!

A cross-platform git GUI for Windows, Linux, and OSX.

Made with NW.js and Vue.js

This is the first pass at a lo-fi mockup for the design of the app.

Sporkle! mockup


Running locally for development

Prerequisites:

  1. Volta - Installed globally (handles Node/npm versions)
  2. git - Installed globally

Instructions:

  1. Fork/clone/download this repo
  2. npm install
  3. npm start

KEY FEATURES

These features are the core value that this project offers and is what is mostly lacking in alternatives:

  1. Horizontal branch comparison graph that ONLY supports 2 branches (the base and the fork)
  2. Per-character diffing (Example)
  3. Dead simple, beginner friendly, highly intuitive

Features in Priority order

  • Be able to add/remove a local repo to the sidebar
  • Switch between repos
  • Store settings locally in a JSON file
  • Filter Sidebar
  • Have swappable themes including: Light (professional), Dark (Low contrast)
  • See a history of all commits on the current branch listed in the middle pane
  • Switch branches
  • Clone a remote repo to a local destination
  • See a diff of files
    • (inlcuding per-char diffs)
  • Visually compare against 1 other branch
  • Pull and push commits
  • Select files for commits
  • Create commits
  • Select lines for commits
  • Discard all changes that have not been commited yet (git checkout HEAD -- path/to/file.js - resets file to last commit)
  • Discard all changes in just one file
  • Create repos in the app
  • Merge in latest from other branch
  • Undo most recent commit (only if it was not pushed)
  • Have High Contrast theme (WCAG 2.0 AAA compliant)
  • Internationalize the app so it can be translated
  • Check for updates
  • Organize Repos in sidebar

OS Support

  • Once released, we intend to support Windows, Linux, and OSX equally.
  • Which version of each OS to support has not been decided yet
  • We will not be supporting "Code-Signed" packages unless someone wants to help set that up.
  • We will not be supporting any OS app store (unless someone wants to help set that up).

Technology Colophon

  • git
  • NW.js
  • NW.js Builder Phoenix
    • May replace this with nw-builder later
  • Vite
  • Vue.js
  • Pinia
  • Remix Icons
  • Vue-Router
  • NW-Vue-Devtools
  • ESLint
  • VMWare
  • VirtualBox
  • GitHub Actions

About

User Friendly, Cross-Platform, Git Client (made with Vue + NW.js)

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •