Skip to content

README.md

Latest commit

 

History

History
107 lines (83 loc) · 4.09 KB

README.md

File metadata and controls

107 lines (83 loc) · 4.09 KB

git-creator 🚀

Build a stunning GitHub profile in minutes.
30+ Premium Templates • Live Preview • GitHub Auto-Fill • One-Click Export

Explore the App »

Report Bug · Request Feature

🌟 Features

  • 30+ Premium Templates — Modern, Animated, Minimal, Student, Open Source, and more.
  • GitHub Data Integration — Instantly fetch your profile stats, bio, and top languages.
  • Dynamic Social Badges — Standardized Shields.io badges for LinkedIn, Instagram, X, etc.
  • Live Markdown Editor — Real-time preview with support for manual markdown tweaks.
  • Modular Sections — Toggle sections like Streak Stats, Trophies, Activity Graph, and Spotify.
  • One-Click Export — Download your README.md or copy to clipboard instantly.
  • Rich Tech Stack Icons — Integrated with SkillIcons for beautiful tool displays.

🛠 Tech Stack

Layer Technology
Framework TanStack Start + React 19
Styling Tailwind CSS v4 + Vanilla CSS
Animation Framer Motion
Icons Lucide + React Icons
State Zustand
Markdown Shields.io + GitHub Readme Stats

📂 Template Library

Our library features 30+ premium templates categorized for every type of developer. You can find all the raw markdown files in the md-templates/ directory.

Categories Available:

  • 🎨 Minimal & Elegant: Clean designs for a professional look.
  • ✨ Animated & Dynamic: Using SVG animations and interactive elements.
  • 🚀 Full-Stack & Engineering: Comprehensive layouts with tech stacks and project grids.
  • 🎓 Student & Learner: Track your journey, learning progress, and goals.
  • 🌐 Open Source & Community: Showcase your contributions, stats, and maintainer status.
  • 🧬 Specialized: AI/Data Science, Web3/Crypto, and Portfolio-first designs.

Tip

Each template is built to be highly modular. Our engine automatically detects the <!-- SECTION:xx --> tags in these files to inject your dynamic GitHub data!

📁 Project Structure

git-creator/
├── md-templates/      # 📂 ALL Markdown templates are stored here (.md)
├── src/
│   ├── components/    # Reusable UI components
│   ├── lib/           # Core builder logic & utilities
│   └── routes/        # TanStack Router file-based pages
├── public/            # Static assets
└── package.json       # Dependencies & scripts

🚀 Getting Started

Installation

  1. Clone the repo: 
    git clone https://github.com/dhairyagothi/git-creator.git
  2. Install dependencies: 
    npm install
  3. Run development server: 
    npm run dev

🤝 Contributing

We love contributions! If you want to add a new template, simply:

  1. Create a new .md file in the md-templates/ directory.
  2. Follow the standard section formatting.
  3. Open a Pull Request!

Check out CONTRIBUTING.md for more details.

📄 License

Distributed under the MIT License. See LICENSE for more information.

Built with ❤️ by Dhairya Gothi