Skip to content
Rey004Public

About

RepoStory compiles commits, technology stats, and milestone chronologies from any public GitHub repository into a beautifully styled, shareable visual card.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Repository files navigation

RepoStory Logo

RepoStory

Turn your GitHub repository stats into beautiful developer story cards.


📖 Description

RepoStory is a cyberpunk-themed web app that analyzes public GitHub repositories. It processes commits, languages, and releases to generate a customized Trading-Card infographic showcasing the project's developer archetype (e.g., Solo Builder, Rising Star) and commit habits (Night Owl, Weekend Warrior).


⚡ Features

  • Dynamic Customization: Choose custom colors (defaulting to neon green #00ff66) and toggle between Light and Dark mode.
  • Easy Exporting: Export cards as high-quality PNGs or copy them to your clipboard.
  • Rich Analytics: Includes milestone flowcharts, a commit activity grid, and language distributions.
  • Gemini AI Summaries: Optionally uses Google Gemini API to write witty, developer-focused stories about the repository.

🧠 Smart Profiling

🛡️ Archetypes

Archetype Badge Icon Description
Solo Builder Solo Builder 👤 Crafted single-handedly by one developer.
Rising Star Rising Star 🚀 A new repository experiencing rapid adoption.
Hidden Gem Hidden Gem 💎 Highly useful utility with many forks, flying under the radar.
Community Favorite Community Favorite 👥 A bustling collaborative effort backed by multiple contributors.
Legacy Giant Legacy Giant 🏛️ Stable, mature, and battle-tested standard.
Active Explorer Active Explorer 🧭 Steady progress with solid utility.

🕒 Commit Habits

Habit Pattern Badge Icon Schedule
Night Owl Night Owl 🦉 High activity between 11 PM and 5 AM.
Early Bird Early Bird 🌅 Active during early morning hours.
Daylight Developer Daylight Developer ☀️ Active during standard daytime business hours.
Weekend Warrior Weekend Warrior ⚔️ Commits heavily on Saturdays and Sundays.
Office Hours Only Office Hours Only 👔 Commits exclusively during weekday business hours.
Weekday Warrior Weekday Warrior 💻 Active during the workweek with low weekend commits.

🛠️ Local Setup Guide

Prerequisites

  • Node.js (v18+ recommended)
  • npm

Steps

  1. Clone & Navigate:

    git clone https://github.com/Rey004/RepoStory.git
    cd RepoStory
  2. Install:

    npm install
  3. Configure Environment (Optional): Create a .env file in the root:

    # Required to avoid rate limits (5,000 reqs/hr vs 60/hr)
    GITHUB_TOKEN=your_github_token_here
    
    # Optional: For AI-generated narratives
    GEMINI_API_KEY=your_gemini_api_key_here
  4. Run Dev Server:

    npm run dev

    Open http://localhost:3000.

  5. Build for Production:

    npm run build
    npm run start

🔑 GitHub API Rate Limits

Auth Status Rate Limit Capacity Badge Recommendation
Unauthenticated 60 requests / hr ~5-6 repositories Limit Best for quick local tests.
Authenticated 5,000 requests / hr ~700 repositories Limit Required for standard use.

🌟 Show Your Support

Please give this repository a Star if you like the project!

Star RepoStory


Built with 💚 by Revanshu

About

RepoStory compiles commits, technology stats, and milestone chronologies from any public GitHub repository into a beautifully styled, shareable visual card.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages