⚠️ This project is currently under active development. Features, UI, and code structure may change frequently. 👐 This project is open source and welcomes contributions from everyone! Beginners and advanced developers are encouraged to participate.
Professional GitHub README Generator
Create stunning GitHub profiles with beautiful templates, advanced analytics, and modern design
ProfileCraft Pro is the ultimate GitHub README generator designed for developers who want to create professional, eye-catching profiles that stand out. With advanced templates, comprehensive analytics integration, and modern design patterns, it's the complete solution for showcasing your developer journey.
- 🎨 Professional Templates: Modern, classic, and minimal designs
- 📊 Advanced Analytics: GitHub stats, activity graphs, and contribution insights
- 🛠️ Tech Stack Showcase: Beautiful tech stack displays with icons
- 📱 Responsive Design: Perfect on all devices
- 🌙 Dark/Light Mode: Complete theme support
- 🚀 One-Click Generation: Instant README creation
- 🔧 Zero Configuration: Works out of the box
We welcome contributions! Please see CONTRIBUTING.md for guidelines and development setup instructions.
| Feature | Description | Status |
|---|---|---|
| Template System | Multiple professional templates | ✅ Available |
| GitHub Integration | Real-time stats and analytics | ✅ Available |
| Tech Stack Builder | Visual tech stack with icons | ✅ Available |
| Project Showcase | Portfolio-style project display | ✅ Available |
| Social Links | Comprehensive social media integration | ✅ Available |
| Analytics Dashboard | Advanced GitHub metrics | ✅ Available |
| Mobile Responsive | Perfect mobile experience | ✅ Available |
| Dark Mode | Complete dark/light theme support | ✅ Available |
| Modern | Classic | Minimal |
|---|---|---|
 |
 |
 |
| Animated profiles with stats cards | Traditional GitHub style enhanced | Clean, content-focused design |
- GitHub Stats: Real-time statistics and insights
- Contribution Graphs: Beautiful activity visualizations
- Language Analytics: Top languages with detailed breakdown
- Streak Tracking: Contribution streak monitoring
- Trophy System: Achievement showcase
- Repository Insights: Enhanced repo statistics
Node.js 18+ and npm/yarn installed# Clone the repository
git clone https://github.com/profilecraft-pro/readme-generator.git
# Navigate to project directory
cd readme-generator
# Install dependencies
npm install
# Start development server
npm run dev# Create production build
npm run build
# Preview production build
npm run preview# Deploy to Vercel (recommended)
vercel
# Or deploy to Netlify
netlify deploy --prod --dir=dist- Personal Details: Enter your information and GitHub username
- Choose Template: Select from Modern, Classic, or Minimal designs
- Tech Stack: Add your programming languages and tools
- GitHub Stats: Configure your analytics and themes
- Advanced Features: Enable metrics, projects, and social links
- Generate: Copy or download your professional README
- Color Schemes: Multiple color palettes
- Dark/Light Mode: Theme preferences
- Profile Images: Custom banners and avatars
- Animations: Subtle motion effects
- Real-time Stats: Live GitHub statistics
- Custom Themes: Match your profile style
- Advanced Metrics: Detailed insights
- Activity Graphs: Visual contribution patterns
- Auto-detection: Import from GitHub repos
- Icon Library: Comprehensive tech icons
- Categorization: Organized by type
- Custom Additions: Add any technology
profilecraft-pro/
├── 📁 public/
│ ├── favicon.ico
│ ├── site.webmanifest
│ └── og-image.png
├── 📁 src/
│ ├── 📁 components/
│ │ ├── PersonalDetailsForm.tsx
│ │ ├── ProfileTemplateForm.tsx
│ │ ├── TechStackForm.tsx
│ │ ├── GitHubStatsForm.tsx
│ │ ├── MetricsForm.tsx
│ │ ├── ProjectsForm.tsx
│ │ ├── SocialLinksForm.tsx
│ │ ├── ContactForm.tsx
│ │ └── ReadmePreview.tsx
│ ├── 📁 utils/
│ │ ├── modernTemplateGenerator.ts
│ │ ├── classicTemplateGenerator.ts
│ │ ├── minimalTemplateGenerator.ts
│ │ ├── githubStatsGenerator.ts
│ │ ├── advancedAnalyticsGenerator.ts
│ │ └── readmeGenerator.ts
│ ├── 📁 types/
│ │ └── index.ts
│ ├── App.tsx
│ ├── main.tsx
│ └── index.css
├── package.json
├── vite.config.ts
├── tailwind.config.js
└── README.md
# Optional: GitHub API Token for enhanced features
VITE_GITHUB_TOKEN=your_github_token_here// Add custom color schemes in ProfileTemplateForm.tsx
const colorSchemes = [
{ id: 'custom', name: 'Custom Theme', colors: ['#hex1', '#hex2', '#hex3'] }
];// Configure in githubStatsGenerator.ts
const themes = ['default', 'radical', 'merko', 'tokyonight', 'dracula'];- ⚡ Lighthouse Score: 95+ across all categories
- 🚀 First Contentful Paint: < 1.2s
- 📱 Mobile Responsive: 100% compatible
- 🌐 Browser Support: All modern browsers
- 🎯 Meta Tags: Comprehensive SEO setup
- 📋 Structured Data: JSON-LD implementation
- 🔗 Open Graph: Social media optimization
- 🐦 Twitter Cards: Enhanced sharing
We welcome contributions! Here's how you can help:
- Check existing issues
- Create detailed bug report
- Include reproduction steps
- Add screenshots if applicable
- Search existing requests
- Create detailed proposal
- Explain use case
- Provide mockups if possible
- Fork the repository
- Create feature branch:
git checkout -b feature/amazing-feature - Commit changes:
git commit -m 'Add amazing feature' - Push to branch:
git push origin feature/amazing-feature - Open Pull Request
- Use TypeScript for type safety
- Follow ESLint configuration
- Write meaningful commit messages
- Add tests for new features
This project is licensed under the MIT License - see the LICENSE file for details.
MIT License
Copyright (c) 2025 ProfileCraft Pro
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
- GitHub - For the amazing platform and APIs
- Vercel - For hosting and deployment
- Tailwind CSS - For the beautiful styling system
- React Team - For the incredible framework
- Open Source Community - For inspiration and contributions
- 📖 Documentation: Check our comprehensive guides
- 💬 Discussions: Join our GitHub Discussions
- 🐛 Issues: Report bugs on GitHub Issues
- 📧 Email: support@profilecraft-pro.com
