Go to file
Marcel van Remmerden f6c5d0d76d Merge branch 'docs-challenges' into 'main'
Document challenges while bootstrapping and working on GitDock

See merge request mvanremmerden/gitdock!30
2021-10-24 09:47:09 +00:00
.circleci Set up GitHub Actions workflow 2021-07-24 19:35:22 +02:00
.github Update node and npm for lockfile version support 2021-08-01 07:24:05 +02:00
assets Properly escape all user input to be displayed 2021-08-04 13:05:44 +02:00
docs Document challenges while bootstrapping and working on GitDock 2021-10-24 09:47:09 +00:00
lib Add tests for "Recently viewed" section 2021-10-24 09:06:08 +00:00
src Added prettier to fix code style 2021-10-14 21:50:09 +00:00
test Add tests for "Recently viewed" section 2021-10-24 09:06:08 +00:00
.gitignore Set up GitHub Actions workflow 2021-07-24 19:35:22 +02:00
.gitlab-ci.yml Add permanent link to assets 2021-10-23 20:22:34 +00:00
.mocharc.js Add basic mocking 2021-10-23 16:45:40 +00:00
.prettierignore Added prettier to fix code style 2021-10-14 21:50:09 +00:00
.prettierrc Added prettier to fix code style 2021-10-14 21:50:09 +00:00
LICENSE Clarify that GitDock is under MIT License 2021-08-05 09:20:19 +02:00
README.md Added prettier to fix code style 2021-10-14 21:50:09 +00:00
index.html Added prettier to fix code style 2021-10-14 21:50:09 +00:00
login.html Added prettier to fix code style 2021-10-14 21:50:09 +00:00
myApp.js Merge branch '57-add-private-project-into-favorite-projects' into 'main' 2021-10-24 09:15:47 +00:00
package-lock.json Fix private project detection 2021-10-24 11:31:38 +03:00
package.json Fix private project detection 2021-10-24 11:31:38 +03:00
preload.js Added prettier to fix code style 2021-10-14 21:50:09 +00:00
renderer.js Added prettier to fix code style 2021-10-14 21:50:09 +00:00
style.css Added prettier to fix code style 2021-10-14 21:50:09 +00:00

README.md

GitDock

GitDock is a MacOS/Windows/Linux app that displays all your GitLab activities in one place. Instead of the GitLab typical project- or group-centric approach, it collects all your information from a user-centric perspective.

You can either have a look at this walkthrough video I recorded, or just try it out yourself by downloading it from the releases.

YouTube Video

Installation

As GitDock hasn't been digitally signed and verified (yet), the installation requires a few more steps than usual.

MacOS
  1. Grab the dmg file from the newest release on the Releases page.
  2. Move the app to your Applications folder and open it. You will see a notification asking you "". Click "Cancel" at this point.

Installation warning

  1. Open "Settings -> Security & Privacy" in your MacOS System Preferences, and make sure you are on the "General" tab.
  2. You should now see a message about GitDock in the lower part. After clicking "Open anyway", it should work as expected 🎉

Security & Privacy warning

Windows

//TODO Add Windows installation instructions

How to use GitDock

Authentication

Depending on whether you use GitLab.com or a self-managed instance, you can either log in directly with your username and password, or create a personal access token.

GitLab.com

Just click the "Login with GitLab" button, and then enter your username and password. Afterwards, you might be seeing the GitLab homepage, but should very quickly and automatically be redirected to your GitDock overview page.

Start Login
Start page Login page
Self-managed installation

To log in with an account from a self-managed instance, you first have to create a personal access token:

Go to the Access Tokens page by first opening the user dropdown, clicking "Preferences" and then navigating to "Access tokens" in the left sidebar.

User dropdown Access tokens
Preferences Access tokens

Enter a token name, mark the read_api checkbox and then click "Create personal access token". On the following screen, copy the newly created access token and paste it into the GitDock application, together with the URL of your self-managed instance.

Notifications

Pipelines

Whenever you start a new pipeline, a system notification shows up and the GitDock icon in the menu bar changes to a running pipeline icon. Once the pipeline completes, you will receive another notification with the final pipeline status.

Running Completed
Running pipeline Completed pipeline

To-Dos

Whenever a new To-Do gets created for you, the system notification will show you the message, project and object where it's coming from.

To-Do notification

My Issues, MRs & To-Do list

At the top of the app, you will see the typical sections of issues, MRs and the To-Do list.

Top section

You might be used to this layout already from our GitLab UI. The only difference is that on the detail pages, you can more easily switch directly to the objects you care about by using the filters to e.g. see the last MRs you have approved and that have already been merged.

Issues MRs To-Do list
Issues Merge requests To-Dos

My commits

The first piece of content on the overview page is a list of your most recent commits. They show the commit title, project, and (if applicable) the current pipeline status for that commit. You can also navigate to each of these areas from that overview.

My commits

Recently viewed

GitDock uses your browser history to display the GitLab pages you most recently visited. Due to how it parses that information, it currently only works on Windows and MacOS with the following browsers: Chrome, Firefox, Edge, Opera, Brave, Seamonkey.

Recently viewed

On the detail page, you can go over all pages you visited over the last 10 days, and also search for specific links, if you happen to remember a certain keyword.

Recently viewed overview

Favorite projects

The list of your favorite projects initially are the projects you have starred and where you have at least developer permissions.

Favorite projects

After navigating to a project in this overview, you will be able to see the commits, issues and merge requests of that project.

Project detail

You can add/remove projects from this list on the Settings page.

Project settings

Your comments

A list of all your recent comments is also visible on the overview page. Due

Comments

The loading time for comments is significantly longer than for other objects, as each comment requires 3 API calls to collect all necessary information.

Bookmarks

If you have a specific issue or merge request you care about and know you will have to access multiple times over the next days, you can add it to you Bookmarks list.

Bookmarks

Settings

Theme

To make Gitdock as accessible and usable as possible, you can switch between dark and light theme.

Dark Light
Dark Light

Analytics

Analytics is disabled by default, you have the chance to opt in on the Settings page.

Analytics

How to contribute

The most important part of contributing right now is helping us gain better insights into how users would like to navigate GitLab in this user-centric approach. That's why it would be amazing to have as many people as possible enable Analytics. As stated in the Settings, it's 100% anonymous and we only track which objects are being used to navigate around, now which specific content (e.g. issues, MRs) users are interacting with.

If you do find any bugs, feel free to open an issue or directly create a merge request if you happen to know the fix.