https://github.com/ahmadalfy/gitlab-explorer

Tool to visualize your groups, repositories, members and activities in your Gitlab space
https://github.com/ahmadalfy/gitlab-explorer

data-visualization gitlab tools tools-engineering

Last synced: about 1 month ago
JSON representation

Tool to visualize your groups, repositories, members and activities in your Gitlab space

• Host: GitHub
• URL: https://github.com/ahmadalfy/gitlab-explorer
• Owner: ahmadalfy
• Archived: true
• Created: 2020-01-22T22:23:53.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-05T03:32:59.000Z (over 1 year ago)
• Last Synced: 2024-03-18T16:47:52.145Z (10 months ago)
• Topics: data-visualization, gitlab, tools, tools-engineering
• Language: JavaScript
• Size: 1.22 MB
• Stars: 39
• Watchers: 3
• Forks: 7
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Gitlab Explorer

Gitlab Explorer is a tool to visualize your groups, repositories, members and activities in your Gitlab space.

## About

This is a side project I started as an attempt to try different technologies like [snowpack](https://www.snowpack.dev/), [Dixie](https://dexie.org/) and [lit-html](https://lit-html.polymer-project.org/). I found it useful so I decided to share it. It collects data from your gitlab account and store it in the browser using [IndexdDb](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API).

With this tool you can check:

* Your groups.

* Projects in your groups and their last activiy.

* Members in your groups and projects and their activities.

* Draw graphs using user activities.

Since everything is stored in your browser, you might want to export the data somewhere to import it again if you want to share it with someone.

## Getting started

1. Clone the repository.

2. Create an access token from your [gitlab settings](https://gitlab.com/profile/personal_access_tokens). You need to grant it access to `api`, `read_user`, `read_repository` and `read_registry`.

3. Copy the `env.sample.js` file to `env.js` and replace the default empty string for token option with your token (for self-hosted servers change the baseUrl option to match your domain).

4. Use an http server to run the application. There's no build steps required and you don't even need to install the required modules.

## Status of this project

This is still work in progress. As a start I am focusing on using the APIs to build useful reports. After extracting enough useful information from the data I plan to rebuild the dashboard and display these information in a better way.

## ⚠️ WARNING ⚠️

This tool require a Gitlab access token to work. That token should be kept safe and hidden. If you deploy it there is a possibility that someone find it and use it to do harm to your work. **Use it at your own risk**.