Streaky

Streaky is a robust web application designed to help users maintain their GitHub contribution streaks effortlessly. By providing instant notifications via Discord and Telegram when a streak is at risk, Streaky acts as a guardian for your coding activities, enabling seamless tracking and consistency.

Key Features

• Instant Notifications: Stay updated on your streak status with real-time alerts, ensuring you never miss a day of contribution.
• Your Data is Secure: Utilizing AES-256-GCM encryption, all sensitive information including GitHub Personal Access Tokens (PAT), Discord webhooks, and Telegram tokens is securely stored.
  • Separate Key Storage: Encryption keys are kept apart from user data, enhancing security.
  • Zero Knowledge Architecture: Your data remains inaccessible, ensuring privacy and peace of mind.
• Automatic Key Rotation: Regular updates and management of encryption keys help maintain high security.

Web Application

The recommended way to use Streaky is through its user-friendly web application, accessible at streakyy.vercel.app.

• Zero Setup Required: Simply sign in with GitHub to begin tracking your streak.
• Daily checks at 12:00 UTC: The application runs continuously on a cloud platform to monitor your streak without interruption.
• Multi-platform Notifications: Receive alerts through Discord and Telegram for maximum convenience.
• Enterprise-grade Security: Featuring JWT authentication, AES-256 encryption, and secure key management to protect user information.

Command Line Interface (CLI) for Developers

For those who prefer a more hands-on approach, Streaky offers a CLI version that can be hosted locally, allowing for extensive customization.

• Self-hosted Installation: Prefer complete control? This option lets users run the application on their own machines.
• Suitable for Automation: Ideal for CI/CD workflows, providing flexibility and integration capabilities.

Quick Start Example

git clone https://github.com/0xReLogic/streaky.git
cd streaky/cli
pip install -r requirements.txt
python main.py

Technology Stack

Streaky is built using modern web technologies designed for performance and scalability:

• Frontend: Next.js 15, TypeScript, and Tailwind CSS for a clean and responsive user experience.
• Backend: Cloudflare Workers, with a focus on high performance through a distributed architecture.
• Notifications Via Rust: Handled by a dedicated Rust notification proxy utilizing the Axum framework and async features for efficiency.

Contributing

Contributions to Streaky are welcome, and interested developers can check the Contributing Guide to get involved. Join a vibrant community dedicated to enhancing productivity for developers.