https://github.com/jamieweavis/streaker

Cross-platform GitHub contribution streak/statistic tracking menu bar application with reminder notification
https://github.com/jamieweavis/streaker

contribution contribution-graph electron electron-app github macos menubar statistics stats streak

Last synced: 5 months ago
JSON representation

Cross-platform GitHub contribution streak/statistic tracking menu bar application with reminder notification

• Host: GitHub
• URL: https://github.com/jamieweavis/streaker
• Owner: jamieweavis
• License: mit
• Created: 2017-05-16T13:07:07.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2025-04-14T13:29:50.000Z (6 months ago)
• Last Synced: 2025-04-14T13:54:53.948Z (6 months ago)
• Topics: contribution, contribution-graph, electron, electron-app, github, macos, menubar, statistics, stats, streak
• Language: TypeScript
• Homepage:
• Size: 16.6 MB
• Stars: 186
• Watchers: 5
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• Mac-Menubar-Megalist - Streaker
• open-source-mac-os-apps - Streaker - GitHub contribution streak tracking menubar app. ![javascript_icon] (Applications / Development)
• jimsghstars - jamieweavis/streaker - 🔥 GitHub contribution streak & stat tracking menu bar app (TypeScript)
• awesome-mac - jamieweavis/streaker - platform GitHub contribution streak & statistic tracking menu bar application with reminder notification ☆`191` (Utilities / Menu Bar Tools)
• awesome-mac - jamieweavis/streaker - platform GitHub contribution streak/statistic tracking menu bar application with reminder notification ☆`190` (Utilities / Menu Bar Tools)

README

          
# Streaker 

Cross-platform GitHub contribution streak/statistic tracking menu bar application with reminder notification

[![ci](https://github.com/jamieweavis/streaker/actions/workflows/ci.yml/badge.svg)](https://github.com/jamieweavis/streaker/actions)

[![downloads](https://img.shields.io/github/downloads/jamieweavis/streaker/total.svg)](https://github.com/jamieweavis/streaker/releases)

[![version](https://img.shields.io/github/release/jamieweavis/streaker.svg)](https://github.com/jamieweavis/streaker/releases)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jamieweavis/streaker/blob/main/LICENSE)



## Install

Download the latest version of Streaker from the **[GitHub releases](https://github.com/jamieweavis/streaker/releases)** page. Or see the **[Building Locally](#building-locally)** section to build it yourself.

## Features

- Menu bar contribution stats

  - Streak

    - Best

    - Current

    - Previous

  - Contributions

    - Most (day)

    - Today

    - Total (year)

- 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 |  |  |  |

| Contributed |  |  |  |

| Streaking |  |  |  |

#### Dark Mode

| State | Flame | Tile | Octocat |

| ----- | ----- | ---- | ------- |

| Pending |  |  |  |

| Contributed |  |  |  |

| Streaking |  |  |  |

## Building Locally

The app is built & deployed for all platforms via GitHub Actions automatically, but you can build it locally for your platform with the following steps:

Clone the repository

```bash

git clone https://github.com/jamieweavis/streaker.git

cd streaker

```

Install npm dependencies (recommended to use Node.js v22)

```bash

npm install

```

Package the app for your current platform

```bash

npm run package

```

The packaged app will now be in the `out/` directory

## Development

Run the app in development mode

```bash

npm run start

```

*Only the renderer process currently supports hot reloading, changes in `src/main/` will require a restart*

## Built with

- [TypeScript](https://github.com/microsoft/TypeScript)

- [Electron](https://github.com/electron/electron)

- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss)

- [Electron Forge](https://github.com/electron/forge)

## Related

- [Streaker CLI](https://github.com/jamieweavis/streaker-cli) - GitHub contribution streak/statistic tracking command line application with ASCII contribution graph

- [Contribution](https://github.com/jamieweavis/contribution) - GitHub contribution graph parser - contribution streak & statistic calculator with zero dependencies

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.