Build an exceptional GitHub profile in seconds with a modern, fluid, and intelligent interface.
The Ultimate README Gen is more than just a form. It's a high-performance design tool for developers that leverages the GitHub API to provide a "High-Tech Stealth" user experience with real-time feedback and smart automation.
Just enter your GitHub username and let the magic happen:
- Profile & Bio: Automatically fetch your basic information and public links.
- Deep Scanning: Textual analysis of your current README to auto-detect your Tech Stack.
- Email Extraction: Smart extraction of your contact address using Regex.
- Drag & Drop: Reorder your sections (Bio, Skills, Stats, Projects, etc.) with ease.
- Smart Layout Manager: Only manage sections you've actually filled.
- Interactive Tour: A guided onboarding for first-time users.
- Keyboard Shortcuts:
CMD+Sto download,CMD+Cto copy,CMD+Kto search,CMD+Tfor theme.
- Themes Gallery: Choose from 10+ themes for your statistics cards.
- Global Alignment: Switch between Classic (Left) or Modern (Centered) modes.
- Badge Factory: Support for 5 different Shields.io badge styles.
- Dynamic Typing SVG: Add animated text with custom fonts, colors, and speeds.
- 🐍 Snake Animation: The famous contribution grid snake.
- 🎵 Spotify Now Playing: Show what you're listening to in real-time.
- 📰 RSS Feed: Automatically list your latest blog posts (Medium, Dev.to, etc.).
- 🖼️ Header Banner: Add a strong visual impact at the top of your profile.
- 📊 GitHub Stats & Trophies: Comprehensive coding metrics and visual achievements.
- ⏱️ WakaTime: Weekly coding activity graphs.
- Service Health Check: Real-time monitoring of third-party APIs.
- Local Persistence: Your progress is always saved automatically.
- CI/CD: Automated testing and linting via GitHub Actions.
| Technology | Usage |
|---|---|
| Next.js 16 (App Router) | High-performance React framework |
| Zustand | Global state management & persistence |
| Tailwind CSS | Atomic and responsive design system |
| Framer Motion | Premium "Stealth" animations |
| @dnd-kit | Vertical Drag & Drop engine |
| Sonner | Modern toast notifications |
| Vitest | Unit testing for the generation engine |
-
Clone the project
git clone https://github.com/D-Seonay/readme-profile-gen.git cd ultimate-readme-gen -
Install dependencies
npm install
-
Start the development server
npm run dev
Open
http://localhost:3000in your browser!
- Phase 1: Core engine, State Persistence, Multi-language.
- Phase 2: Stats, Trophies, WakaTime, Featured Projects.
- Phase 3: Snake, Spotify, RSS, Typing SVG, Header Banners.
- Phase 4: Premium Landing Page, Onboarding Tour, Shortcuts.
- Phase 5: AI-powered Bio generation (OpenAI/Gemini).
- Phase 6: Community Templates & Theme Sharing.
Contributions are welcome!
- Fork the project.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'feat: Add some AmazingFeature'). - Push the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
Developed with ❤️ by Seonay
Generated with Ultimate GitHub Profile README Generator

