🚀 GitHub Profile README Generator

A modern, sleek, and high-performance React application that helps developers generate beautiful, comprehensive, and dynamic GitHub Profile READMEs in seconds.

✨ Features

• 🏢 Basic Information: Add your name, role, company, location, and portfolio link.
• 🌐 Social Links: Easily integrate links to your LinkedIn, X (Twitter), YouTube, Dev.to, Medium, and more.
• 💻 Tech Stack Selector: Choose from a vast array of programming languages, frontend/backend frameworks, databases, and DevOps tools.
• 📊 GitHub Widgets: Toggle dynamic GitHub stats, including Top Languages, Streak Stats, Activity Graphs, and the popular Contribution Snake.
• 👁️ Live Preview: Instantly view the rendered Markdown or the raw code output in real-time.
• 📋 1-Click Export: Easily copy the generated Markdown to your clipboard or download it as a README.md file.

🎨 Tech Stack

• Framework: React (Vite)
• Styling: Tailwind CSS
• Icons: Lucide React
• Markdown Parsing: react-markdown & remark-gfm

🚀 Getting Started

To run this project locally, follow these steps:

Prerequisites

You need to have Node.js installed on your machine.

Installation

1. Clone the repository:

   git clone https://github.com/Hariharapranav/github-profile-readme-generator.git

2. Navigate to the project directory:

   cd github-profile-readme-generator

3. Install the dependencies:

   npm install

4. Start the development server:

   npm run dev

5. Open your browser and visit http://localhost:5173.

🛠️ Building for Production

To create a production build, run:

npm run build

This will generate a dist folder containing the optimized and minified application.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🙏 Acknowledgements

This generator relies on several incredible open-source APIs and tools to render your GitHub statistics and widgets:

• GitHub Readme Stats (and the Eight-theta Mirror) for the GitHub Stats and Top Languages cards.
• GitHub Readme Streak Stats for the Streak Stats widget.
• GitHub Readme Activity Graph for the beautiful dynamic activity chart.
• Snk for the Contribution Graph snake animation.
• GitHub Profile Views Counter for the GHPVC visitor counter.
• Simple Icons for the reliable brand logos used in our UI and badges.
• Shields.io for the clean and customizable badges.

⭐️ Support

If you found this project helpful, please star it on GitHub!

---

Built with ❤️ by Hariharapranav