Create stunning GitHub README profiles in minutes with our intuitive, feature-rich generator
- 50+ Premium Templates - Choose from a vast collection of professionally designed templates
- Category-Specific Designs - Templates for developers, data scientists, designers, and more
- One-Click Application - Apply templates instantly with live preview
- Regular Updates - New designs added frequently
- Drag & Drop Interface - Reorder sections effortlessly
- Custom Color Schemes - Personalize your README with brand colors
- Widget Integration - Add GitHub stats, language charts, and activity graphs
- Markdown Editor - Advanced editing capabilities for power users
- Instant Visual Feedback - See changes as you type
- Multi-Device Preview - Mobile and desktop responsive views
- Dark/Light Mode - Toggle between themes
- GitHub-Accurate Rendering - Exact GitHub markdown preview
- One-Click GitHub Integration - Direct repository updates
- Multiple Export Formats - Markdown, HTML, and more
- Copy with Formatting - Preserve all styling and layout
- Shareable Preview Links - Collaborate with team members
- Gemini Flash 2.5 Integration - Powered by Google's latest AI model
- Intelligent Content Enhancement - Automatically improve descriptions and structure
- Multiple Enhancement Types - Choose from comprehensive, structure, content, or formatting improvements
- Real-Time Preview - See enhanced content in both markdown and rendered views
- Smart Personalization - AI considers your GitHub profile and social links for context
| Frontend | Backend | Database | Deployment |
|---|---|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
||
 |
 |
- Node.js 18.0 or higher
- npm or pnpm package manager
- Git for version control
-
Clone the repository
git clone https://github.com/harshitkumar9030/github_readme.git cd github_readme -
Install dependencies
npm install # or pnpm install -
Set up environment variables
cp .env.example .env.local
Add your environment variables:
MONGODB_URI=your_mongodb_connection_string GITHUB_TOKEN=your_github_personal_access_token NEXTAUTH_SECRET=your_nextauth_secret GEMINI_API_KEY=your_google_gemini_api_key
-
Run the development server
npm run dev # or pnpm dev -
Open your browser Navigate to http://localhost:3000
github_readme/
├── 📂 src/
│ ├── 📂 app/ # Next.js App Router
│ │ ├── 📂 api/ # API endpoints
│ │ │ ├── github-stats-svg/ # GitHub statistics API
│ │ │ ├── language-chart/ # Language chart API
│ │ │ ├── repo-showcase/ # Repository showcase API
│ │ │ └── ... # Other APIs
│ │ ├── 📂 create/ # README builder interface
│ │ ├── 📂 documentation/ # Comprehensive docs
│ │ ├── 📂 templates/ # Template gallery
│ │ └── 📂 feedback/ # User feedback system
│ ├── 📂 components/ # Reusable UI components
│ ├── 📂 widgets/ # Interactive GitHub widgets
│ ├── 📂 services/ # External service integrations
│ └── 📂 utils/ # Utility functions
├── 📂 public/ # Static assets
└── 📋 Configuration files
Our public APIs provide programmatic access to generate dynamic SVG widgets:
GET /api/github-stats-svg?username=octocat&theme=dark&layout=compactGET /api/language-chart?username=octocat&langs_count=8GET /api/repo-showcase?username=octocat&repo=Hello-World&theme=radicalGET /api/animated-progress?skills=JavaScript,Python,React&values=90,85,80&theme=gradientPOST /api/ai-enhance
Content-Type: application/json
{
"content": "Your README content",
"enhancementType": "comprehensive|structure|content|formatting",
"username": "your-github-username",
"socials": { "github": "...", "linkedin": "..." }
}We welcome contributions from the community! Here's how you can help:
Found a bug? Please create an issue with:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Screenshots if applicable
Have an idea? We'd love to hear it! Include:
- Detailed description of the feature
- Use cases and benefits
- Mockups or examples if possible
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Commit your changes:
git commit -m 'Add amazing feature' - Push to the branch:
git push origin feature/amazing-feature - Open a Pull Request
- Follow the existing code style
- Add TypeScript types for new features
- Include tests for new functionality
- Update documentation as needed
"Absolutely mind-blowing! 🤯 This GitHub README generator transformed my boring profile into a stunning showcase that actually reflects my personality as a developer. The drag-and-drop interface is incredibly intuitive, and the real-time preview feature saved me hours of trial and error. What really impressed me was the variety of professional templates - I went from a blank profile to having my friends asking me about it! The animated widgets and custom SVG integrations are pure magic. This tool doesn't just create READMEs; it creates digital portfolios that tell your story. Harshit, you've built something truly exceptional here! 🚀✨"
— Viraj Datta
Web Dev & Open Source Enthusiast
This project is licensed under the MIT License - see the LICENSE file for details.
- Next.js Team for the amazing framework
- Vercel for hosting and deployment platform
- Tailwind CSS for the utility-first CSS framework
- Framer Motion for smooth animations
- Community Contributors for their valuable feedback and contributions
Need help? We're here for you!
- 📚 Documentation - Comprehensive guides and tutorials
- 💬 GitHub Discussions - Community Q&A
- 🐛 Issue Tracker - Bug reports and feature requests
- 📧 Contact - Direct support
⭐ Star this repository if you found it helpful!
Made with ❤️ by Harshit Kumar