Streaker
Cross-platform GitHub contribution streak and statistic tracking menu bar application with reminder notification
Install / Use
/learn @jamieweavis/StreakerREADME
Streaker <img alt="Streaker Logo" align="right" width=40 height=40 alt="Screenshot" src="./.github/icons/icon.svg">
Cross-platform GitHub contribution streak and statistic tracking menu bar application with reminder notification
<img width="716" alt="Screenshot" src=".github/icons/screenshot.png">Install
Download the latest version of Streaker from the GitHub releases page (or see the Development section to build it yourself).
Features
- Menu bar contribution stats
- Streak
- Best
- Current
- Previous
- Contributions
- Most (day)
- Today
- Total (year)
- Streak
- Menu bar icon changes depending on contribution status
- Empty - you haven't contributed today
- Filled - you have contributed today
- Crown - you're currently on your best streak
- Three different menu bar icon themes
- Flame
- Tile
- Octocat
- Reminder notification so you don't lose your streak
Menu Bar Icons
Light Mode
| State | Flame | Tile | Octocat | | ----- | ----- | ---- | ------- | | Pending | <img width="20" alt="Flame Empty" src=".github/icons/pending-flame-mac.svg"> | <img width="20" alt="Tile Empty" src=".github/icons/pending-tile-mac.svg"> | <img width="20" alt="Octocat Empty" src=".github/icons/pending-octocat-mac.svg"> | | Contributed | <img width="20" alt="Flame Contributed" src=".github/icons/contributed-flame-mac.svg"> | <img width="20" alt="Tile Contributed" src=".github/icons/contributed-tile-mac.svg"> | <img width="20" alt="Octocat Contributed" src=".github/icons/contributed-octocat-mac.svg"> | | Streaking | <img width="20" alt="Flame Crown" src=".github/icons/streaking-flame-mac.svg"> | <img width="20" alt="Tile Streaking" src=".github/icons/streaking-tile-mac.svg"> | <img width="20" alt="Octocat Streaking" src=".github/icons/streaking-octocat-mac.svg"> |
Dark Mode
| State | Flame | Tile | Octocat | | ----- | ----- | ---- | ------- | | Pending | <img width="20" alt="Flame Empty" src=".github/icons/pending-flame-mac-white.svg"> | <img width="20" alt="Tile Empty" src=".github/icons/pending-tile-mac-white.svg"> | <img width="20" alt="Octocat Empty" src=".github/icons/pending-octocat-mac-white.svg"> | | Contributed | <img width="20" alt="Flame Contributed" src=".github/icons/contributed-flame-mac-white.svg"> | <img width="20" alt="Tile Contributed" src=".github/icons/contributed-tile-mac-white.svg"> | <img width="20" alt="Octocat Contributed" src=".github/icons/contributed-octocat-mac-white.svg"> | | Streaking | <img width="20" alt="Flame Crown" src=".github/icons/streaking-flame-mac-white.svg"> | <img width="20" alt="Tile Streaking" src=".github/icons/streaking-tile-mac-white.svg"> | <img width="20" alt="Octocat Streaking" src=".github/icons/streaking-octocat-mac-white.svg"> |
Development
Prerequisites
Getting Started
Clone the repository and install dependencies:
git clone https://github.com/jamieweavis/streaker.git
cd streaker
pnpm install
Package the app for your current platform:
pnpm package
The packaged app will now be in the out/ directory
Run the app in development mode:
pnpm start
Only the renderer process currently supports hot reloading, changes in src/main/ will require a restart
Related
- Streaker CLI - GitHub contribution streak & statistic tracking command line application with ASCII contribution graph
- Contribution - GitHub contribution graph parser calculates contribution streak and commit statistics from a user's GitHub contribution graph page
