dmusican / elegit

A GUI client for people who want to learn Git.

Elegit

A graphics-based Git client for teaching people both how to work Git and how Git works.

Getting Elegit

If you just want to use Elegit, visit our website to download the application.

Tutorial

Here is a great tutorial for getting started with Elegit. Thanks to Mike Panitz for this!

Running the source code in IntelliJ:

1. Open IntelliJ.
2. Visit the File, Other Settings, Default Settings menu. In the dialog that pops up, go to Build, Execution, and Deployment, then Build Tools, Maven, Importing. Check the box about 2/3 of the way down the screen by "Automatically Download", next to Documentation.
3. Check out the repository using the "Check out from Version Control option" and paste the GitHub repository URL in.
4. It will ask you to open pom.xml. Choose yes.
5. Let it load.
6. It will ask at some point if you want to auto import settings from Maven; say yes.
7. In the Project Structure menu, under Project, make sure the Project SDK is at least Java Version 8 Update 60.
8. Run the main method of the Main class.

---

Supervised by Dave Musicant.

Carleton College 2015-2017. 1

elegit's Issues

Checking out a branch fails in some situations that work from command line

I believe it has something to do with file deletion. However, if you use the command line to checkout to the branch and then back, the gui will work if you try again.

Support git tags

Make directory TreeView auto refresh when there are changes

Switch layout to horizontal panels

Local and remote panels will now be horizontal

Animations

Perfect the animations.

If possible (when horizontal), add motion to the line when a new commit appears

Branch creation / deletion

Add the ability to make a new branch or delete a branch.

Make "Push" button indicate how many local commits are ready for pushing

So, when you make a local commit, the push button might go from "Push (3)" to "Push (4)" or something

Add ability to delete files, modify, etc. (not just adding)

As of now, you can only add files... What if files get deleted!?

Fix view constraints / spacing issues

Update all documentation

Leave comments everywhere

Implement fetch, merge, push buttons

Commit/branch icon colors

Use more colors in commit squares, especially to depict branches

Finalize conflict resolver.

Current bug: owner = null.
Also: check for files that are both conflicting and modified!

Show tracking status of branches

Indicate whether a branch is strictly local, strictly remote, or local with a corresponding remote branch that it is tracking.

If the last opened repo directory has been deleted, the app won't open

Since the program tries to load the most recently opened repo, it breaks if that repo is no longer there.

Make local/origin branch views actually reflect commits

No error message for when pushes don't work if your branch isn't up-to-date

If you branch isn't up-to-date and you push, nothing happens.

Deal with this better.

The app fails to start if it's trying to find a recent repo that no longer exists

More specific file names in working tree

Right now, if you have two files with the same name but different directories, the working tree will just show their name and you can't tell which is which.

Show parent directory maybe.

Store login info in prefs *securely*

Encrypt login info and store it with the Java Preferences API.
Or something like that.

Menu bar sticks to the top

Add ability to grab remote branches and track them locally

Errors still uncaught

Specifically:

TransportationError:

• Press the fetch button when not logged in
• Press okay on the dialog that follows (the one that tells you to log in)
• Look at console

Uncaught NoOwnerInfoException:

• Try opening an existing repo without logging in

Fix ugly hash name for remote branches

When you checkout a remote branch, then name turns into a scary bunch of letters and numbers

Write a test suite

Use JUnit

Show diffs

If repo name is too big, the "git status" button gets truncated

The button ends up saying something like "git st..."

If anything, it would be better to have the repo name get truncated. The button should be constant.

Fix the mysterious ArrayIndexOutOfBoundsException

It comes up every now and then. From where?!

Support .gitignore and adding files to it

Perhaps use a right-click context menu in the working tree directory panel.

Local/remote branch views display (blank) on startup

instead of having an empty space where they are supposed to go

Most cancel/exit buttons throw errors

Deal with conflicting files

Right now they don't have a "commit action"

Make buttons arrow-shaped

To indicate directionality of push, commit, merge, fetch in relation to the local and remote panels.

Better indicator of local vs. remote in branch dropdown

Custom cells?

SSH key clone support

This is low priority.

Add "Open directory in finder" button

would be nice

Handle CheckoutConflictException error

Caused by: org.eclipse.jgit.errors.CheckoutConflictException: Checkout conflict with files:

This was raised when I tried to checkout a new branch on a repo that presumably had conflicting files with another branch.

Handle it with grace.

Graph error debug message

Found this while working in the GUI.

Exception in thread "Graph Layout (x = 689.0)" java.lang.IndexOutOfBoundsException: Index: 407, Size: 407
    at java.util.ArrayList.rangeCheck(ArrayList.java:653)
    at java.util.ArrayList.get(ArrayList.java:429)
    at com.sun.javafx.collections.ObservableListWrapper.get(ObservableListWrapper.java:89)
    at com.sun.javafx.collections.VetoableListDecorator.get(VetoableListDecorator.java:306)
    at javafx.scene.Parent.computePrefHeight(Parent.java:997)
    at javafx.scene.layout.Region.computePrefHeight(Region.java:1528)
    at javafx.scene.Parent.prefHeight(Parent.java:918)
    at javafx.scene.layout.Region.prefHeight(Region.java:1435)
    at javafx.scene.Node.autosize(Node.java:2866)
    at javafx.scene.Parent.layoutChildren(Parent.java:1105)
    at javafx.scene.Group.layoutChildren(Group.java:226)
    at javafx.scene.Parent.layout(Parent.java:1076)
    at javafx.scene.Group.impl_computeLayoutBounds(Group.java:164)
    at javafx.scene.Node$12.computeBounds(Node.java:3202)
    at javafx.scene.Node$LazyBoundsProperty.get(Node.java:9285)
    at javafx.scene.Node$LazyBoundsProperty.get(Node.java:9255)
    at javafx.beans.binding.ObjectExpression.getValue(ObjectExpression.java:50)
    at com.sun.javafx.binding.ExpressionHelper$Generic.fireValueChangedEvent(ExpressionHelper.java:356)
    at com.sun.javafx.binding.ExpressionHelper.fireValueChangedEvent(ExpressionHelper.java:81)
    at javafx.scene.Node$LazyBoundsProperty.invalidate(Node.java:9295)
    at javafx.scene.Node.impl_layoutBoundsChanged(Node.java:3380)
    at javafx.scene.Node.impl_notifyLayoutBoundsChanged(Node.java:3793)
    at javafx.scene.Node.impl_geomChanged(Node.java:3744)
    at javafx.scene.Parent.childBoundsChanged(Parent.java:1746)
    at javafx.scene.Node.notifyParentOfBoundsChange(Node.java:3815)
    at javafx.scene.Node.transformedBoundsChanged(Node.java:3777)
    at javafx.scene.Node.localBoundsChanged(Node.java:3759)
    at javafx.scene.Node.impl_geomChanged(Node.java:3745)
    at javafx.scene.Parent.childVisibilityChanged(Parent.java:1759)
    at javafx.scene.Node$5.invalidated(Node.java:1138)
    at javafx.beans.property.BooleanPropertyBase.markInvalid(BooleanPropertyBase.java:109)
    at javafx.beans.property.BooleanPropertyBase.access$000(BooleanPropertyBase.java:49)
    at javafx.beans.property.BooleanPropertyBase$Listener.invalidated(BooleanPropertyBase.java:245)
    at com.sun.javafx.binding.ExpressionHelper$SingleInvalidation.fireValueChangedEvent(ExpressionHelper.java:137)
    at com.sun.javafx.binding.ExpressionHelper.fireValueChangedEvent(ExpressionHelper.java:81)
    at javafx.beans.property.BooleanPropertyBase.fireValueChangedEvent(BooleanPropertyBase.java:103)
    at javafx.beans.property.BooleanPropertyBase.markInvalid(BooleanPropertyBase.java:110)
    at javafx.beans.property.BooleanPropertyBase.set(BooleanPropertyBase.java:144)
    at edugit.treefx.Cell.lambda$new$4(Cell.java:84)
    at edugit.treefx.Cell$$Lambda$95/1824667276.changed(Unknown Source)
    at com.sun.javafx.binding.ExpressionHelper$SingleChange.fireValueChangedEvent(ExpressionHelper.java:182)
    at com.sun.javafx.binding.ExpressionHelper.fireValueChangedEvent(ExpressionHelper.java:81)
    at javafx.beans.property.IntegerPropertyBase.fireValueChangedEvent(IntegerPropertyBase.java:106)
    at javafx.beans.property.IntegerPropertyBase.markInvalid(IntegerPropertyBase.java:113)
    at javafx.beans.property.IntegerPropertyBase.set(IntegerPropertyBase.java:147)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:95)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCellAndChildColumn(TreeLayout.java:112)
    at edugit.treefx.TreeLayout$1.relocateCells(TreeLayout.java:66)
    at edugit.treefx.TreeLayout$1.call(TreeLayout.java:45)
    at edugit.treefx.TreeLayout$1.call(TreeLayout.java:31)
    at javafx.concurrent.Task$TaskCallable.call(Task.java:1423)
    at java.util.concurrent.FutureTask.run(FutureTask.java:266)
    at java.lang.Thread.run(Thread.java:745)

Make everything look pretty

Add notification pane instead of dialogs

using ControlFX
http://controlsfx.bitbucket.org/org/controlsfx/control/NotificationPane.html

Add right-click context menu to Working Tree panel

Things to put in the menu:

• Ignore
• Discard
• Resolve conflict in external editor (if applicable)

Test on other operating systems

Linux, Windows

Use repositories without having to enter a password

Right now you can open a repository from GitHub that requires a username and password.

What if you don't need to enter that information?

Export the project into an executable

Add ability to merge two commits

Conduct another user study

With other researchers on campus?

Pick a license (and name) and make the repo public

Initialization fails when loading an empty repo

Multiple repo support

(with dropdown)

Support for branches