Skip to content

NepoReadme is a free, fast, and feature-rich tool designed to help developers create a polished and informative GitHub profile page.

License

Notifications You must be signed in to change notification settings

Sandipeyy/NepoReadme

Repository files navigation


🪄 What is NepoReadme?

NepoReadme is a modern, responsive web app that lets developers generate beautiful, customizable GitHub Profile READMEs instantly — no login required.

Preview


✨ Features

  • No Authentication: Start creating your README immediately.
  • 🪞 Live Markdown Preview: See updates in real-time.
  • 💎 Rich Widgets: GitHub stats, language cards, streak stats, trophies, and visitor counters.
  • 🌐 Social Links: Twitter, LinkedIn, Instagram, and personal websites.
  • 💾 Easy Export: Copy or download as README.md.
  • 📱 Fully Responsive: Optimized for all devices with sleek dark & purple UI.

🧠 Tech Stack

Category Technology
Framework Next.js 15
Styling TailwindCSS v4
UI Components shadcn/ui
State Management Zustand
Icons Custom SVG + Lucide React
Deployment Vercel

🧩 How to Use

  1. Go to the Editor page.
  2. Enter your GitHub username.
  3. Add optional details: bio, links, skills, donation links.
  4. Enable widgets as needed.
  5. Preview changes live.
  6. Copy or download the markdown output.

🧱 Widgets

  • 🧮 GitHub Stats Card
  • 🧰 Top Languages
  • 🔥 Streak Stats
  • 🏆 GitHub Trophies
  • 👀 Visitor Counter

🧾 License

GPL-3.0 License — see the LICENSE file.

Forks/deployments must retain visible credit to NepoReadme.


💡 Contributing

  1. Fork the repo
  2. Create a branch: git checkout -b feature/AmazingFeature
  3. Commit: git commit -m 'Add AmazingFeature'
  4. Push: git push origin feature/AmazingFeature
  5. Open a Pull Request

🧭 Acknowledgments


❤️ Support

If you enjoy NepoReadme:

  • ⭐ Star the repo
  • 🔁 Share with other developers
  • 🧠 Suggest features
  • 🐛 Report issues via GitHub Issues

Releases

No releases published

Packages

No packages published