jlpatter/oldorangegitfish

An Electron Git GUI application

Deprecated in favor of this project: https://github.com/jlpatter/oxidized_git

OrangeGitFish

This is my electron Git GUI application, OrangeGitFish! I aim to provide the majority of features that git provides but within a GUI!

Features so far:

• Initialize an empty repository
• Open a repository
• Clone a repository
• Fetch
• Pull
• Push
• Stage files (individual or all)
• Unstage (i.e. reset) files
• Commit changes
• View the history in the graph
• Checkout branches
• Create new branches
• And more!

Running on Linux

You will need to run the following commands in order to properly save credentials.

• Debian/Ubuntu: sudo apt install libsecret-1-dev
• Red Hat-based: sudo yum install libsecret-devel
• Arch-based: sudo pacman -S libsecret

Development

Setup environment: run npm install, then run npm run install-app-deps (which takes a really long time as it's compiling nodegit). If those steps throw any errors, be sure to install the missing dependencies or log an issue. You may want to install nvm and run nvm use in the project directory in order to use the correct version of node.

Windows Development

Perform the following steps in order:

• Install Python2 and Python3
• Install the LTS version (<17) of Nodejs (DO NOT use nvm unless you know what you're doing)
• When installing Nodejs, be sure to select the option to install additional compilation tools and such (if the install fails/hangs halfway through, this is normal).
• Make sure that Chocolatey is installed
• (Potentially optional) install visual studio community 2017
• Run the following: choco install visualstudio2017buildtools (yes, even if visual studio community 2017 is installed. Also, 2017 specifically is required as it is hardcoded in nodegit)
• Run the following: choco install openssl (yes, even though it gets built during npm install)
• Run the following: choco install nasm and add the directory containing the NASM executable to your PATH variable (yes, even though it's bundled with nodejs)
• Install Strawberry Perl
• Clone OrangeGitFish somewhere
• In the OrangeGitFish directory, Run npm install
• Run npm run install-app-deps
• Run npm run start

oldorangegitfish's Issues

Add JSHint

Add JSHint to lint all the JavaScript.

Add commit signature setup

Set it up so the user enters their name and email somewhere so they can be used for committing stuff.

Add Init Repo Button

Add a button to initialize a repository.

Add git merge

Add conflict resolution system

Add some way to resolve merge conflicts

Add JIRA REST API support

Add support for linking issues to branches.

Refactor folder structure

Put index.js and preload.js into the backend folder and create a frontend folder.

Add GitHub REST API support

Add functionality so that branches can be tied to GitHub PRs. Also add functionality to tie commits (and branches?) to GitHub issues.

Fix cloning folder selection

When selecting a folder, the clone operation wants an empty folder to perform the clone in for some reason. Figure out why that is and if there's a way around it.

Add progress bar when loading repo

Store git credentials securely

Maybe use this? https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage
From this question: https://stackoverflow.com/questions/69644559/how-to-store-github-patpersonal-access-token-for-app-use

Fix pulling not working

It is currently broken due to the change in nodegit version.

Change the usage of numbers to enums for Diffs

This Enum more specifically: https://www.nodegit.org/api/diff/#DELTA

Add option for forgetting password and setting ssh keys in options menu

Add locally stored preferences

These would include preferences made to the application.

Fix commit graph getting wider on resize

This may only occur on the mac version, but I'm unsure.

Add Clone Repo button

Add a button to clone a repository.

Add git reset

Add soft, mixed, and hard resets

Fix the formatting of the various prompts

Add ability to checkout specific commits

Add ability to add remote repos

Add option for date sort in an options menu

Right now it sorts first by date then topologically. It may be possible to sort topologically first then by date if either the branch order is dependent on the branches passed in to the revwalk or if we can build the tree one branch at a time and add them to a mainline.

Fix branches column formatting

Fix it so that the branches column doesn't overflow on the x or y.

Fix issue with graph showing merge branches incorrectly occasionally

Sometimes regular branches are being shown as merging into other branches.

Set up SSH Authentication

Title. So you can access repos that use ssh authentication.

Make branches double-clickable

Branches in the branch table should be double-clickable such that when they're double clicked it checks out that branch (instead of using the buttons).

Add ability to delete branches

Both local and remote.

Set icon for application

So it doesn't default to the electron icon.

Add labels to unstaged and staged files

These labels would be emojis or icons for "added", "modified", "removed", and "unknown" (possibly "renamed").

Add ability to stage individual files

Currently I can only stage all the files at once. There needs to be a way to stage individual files.

Add context menu

When right-clicking commits in the commit table, a context menu should appear with options relevant to that commit.

Optimize loading graph

Move stageall button to the Unstaged Commits header

Reformat main table

Maybe it shouldn't be a table?

Add git rebase

Add icons for buttons and such

Add error handling

For when users try to do things like checkout a branch while there are uncomitted changes

Add ability to view file diffs

As in, see what additions, changes, and deletions are made to a file.

Add tabs for multiple repos

Add tabs at the top for having multiple repos open at a time.

Add create branch button

Fix resizing the svg element having to reload the whole table

Currently when the svg table is rescaled, it has to refresh the table. This is a problem leftover from when I was using a canvas tag.

Limit the amount of commits to 2000

At least on the main line.

Figure out how Squirrel works

Maybe need some extra configuration to get it to work? See: https://www.electronforge.io/config/makers/squirrel.windows and https://js.electronforge.io/maker/squirrel/interfaces/makersquirrelconfig

Research JavaScript testing

Use the npm command to run tests of some sort.

Add ability to unstage files

Currently files can only be staged, they should be able to be unstaged as well.

Refactor graph structure

Currently the graph only shows one continuous branch. It should show branches going in separate directions.

Investigate a better way of packaging for linux

Maybe start here: https://www.electronforge.io/config/makers

Add on-hover effect to branch tables and commit table

When you hover over the branches, they should light up (bootstrap has this functionality I'm pretty sure). The commit table may be a bit more challenging.

Investigate how electron handles form submission

I want to see if there's a mechanism for form submission so we don't have to use ipc so much.

Add different colors to commit graph

The different indentation levels should use different colors.