Skip to content

AshrafMorningstar/github-stats-automator

# github-stats-automator 🚀

**Auto‑generate dazzling GitHub profile statistics, language breakdowns, and ready‑to‑use README assets in seconds.**  
*Crafted by Ashraf Morningstar – the go‑to toolkit for developers who want their GitHub presence to go viral.*

---

## 🔥 Why This Project?

- **Viral Visibility:** Turn raw repo data into eye‑catching visuals that sky‑rocket your profile’s click‑through rate.  
- **Zero‑Config Magic:** One‑liner install, zero manual tweaking – just run and watch the magic happen.  
- **SEO‑Optimized Output:** Every generated README, badge, and image is pre‑tagged for maximum search engine traction.  
- **Open‑Source Friendly:** Fully extensible, MIT‑licensed, and ready for community contributions.

---

## ✨ Key Features

- **📊 Real‑time GitHub Stats:** Stars, forks, contributions, and more rendered as sleek SVG/PNG cards.  
- **🖥️ Language Heatmaps:** Automatic language usage charts powered by Remotion (React + FFmpeg).  
- **🛠️ Auto‑Apply Copyright:** Python script (`auto_apply_copyright.py`) injects proper licensing headers into all source files.  
- **📝 Dynamic README Builder:** Generates a polished `README.md` with embedded stats, badges, and custom sections.  
- **⚙️ VSCode Ready:** Pre‑configured `.vscode/settings.json` for linting, formatting, and instant debugging.  
- **🤝 Contribution Suite:** Complete `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and issue templates to foster a healthy community.

---

## 🚀 Installation & Usage

### Prerequisites
- **Node.js** (>=14)  
- **Python** (>=3.8)  
- **Git** (for cloning)

### Step‑by‑Step

```bash
# 1️⃣ Clone the repo
git clone https://github.com/yourusername/github-stats-automator.git
cd github-stats-automator

# 2️⃣ Install Node dependencies
yarn install   # or npm install

# 3️⃣ Install Python requirements
pip install -r requirements.txt   # (contains requests, PyYAML, etc.)

# 4️⃣ Run the full pipeline
yarn start    # launches Remotion Studio for preview
yarn render   # builds all stats, language charts, and README

Quick One‑Liner

yarn render && cat README.md

Customization

  • Edit input.json to change your GitHub username, theme colors, or badge styles.
  • Add extra assets to the assets/ folder – the script picks up any *.png or *.svg automatically.
  • Tweak auto_apply_copyright.py to match your preferred license header.

FAQ

Question Answer
Do I need a personal access token? Yes, generate a PAT with repo scope and set it as GITHUB_TOKEN in your environment.
Can I export to PDF? Use yarn render:pdf – the script bundles the README and assets into a single PDF file.
Is there a Docker image? Official image available on Docker Hub: ashraf/github-stats-automator:latest.

🌐 Search Engine Optimization (SEO) Keywords

github profile stats, developer branding, automated readme generator, python copyright script, remotion video stats, open source showcase, seo friendly readme, github activity badge, dynamic markdown assets, viral developer tools

Ready to make your GitHub profile unstoppable? Clone, configure, and let github-stats-automator do the heavy lifting!

About

Auto‑generate stunning GitHub profile stats, language charts, and dynamic README assets with a single command – boost your dev brand instantly.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors