https://github.com/littlebutt/github-panel
Your final desktop tray for Github
https://github.com/littlebutt/github-panel
electron github react
Last synced: 10 months ago
JSON representation
Your final desktop tray for Github
- Host: GitHub
- URL: https://github.com/littlebutt/github-panel
- Owner: littlebutt
- License: mit
- Created: 2024-12-09T12:08:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T13:04:12.000Z (about 1 year ago)
- Last Synced: 2025-03-29T05:34:38.189Z (10 months ago)
- Topics: electron, github, react
- Language: TypeScript
- Homepage:
- Size: 707 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Panel: A desktop tray for Github
## Introduction
Github Panel is a cross-platform, high-efficient and user-friendly desktop tray for Github. Currently, the panel includes three pages: personal information page, personal events page and settings page. The detailed content is as followed:
### Personal Information Page
All your personal basic information includes:
- Avatar
- Login name
- Followers and followings
- Location (if provided)
- Stars earned, commits, pull requests and issues
- Activities in the recent one year
### Personal Events Page
The events showed in your homepage include:
- Event type
- Event actor
- Event action and time
- Event repo
### Settings Page
The basic settings include:
- Your Github Access Token
- The time range for the information provided in personal events page
- Themes and Plugins (support soon)
## Quick Start
1. Apply your [Github Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) if you don't have one
2. Add your Github Access Token to the settings page
3. Save and relaunch the app
Or, you can edit the config in your home directory: `~/gh-panel.toml` or `~/.config/gh-panel.toml`. It is generated automatically if you have launched the app once.
The sample config file is as followed:
```
accessToken = ""
timespan = "30"
[theme/default]
activate = true
[theme/dark]
activate = false
```
## Themes
Support soon
## Plugins
Support soon