📝 GitHub Profile Generator
A Streamlit-based web application that generates stunning GitHub README profiles in seconds! Customize your profile with personal details, tech stack, social media links, GitHub stats, and more, all wrapped in a sleek glassmorphism UI. Choose between Simple or Professional templates and download your README instantly. 🚀
✨ Features 🖼️ Glassmorphism Design: Modern, blurred background with a clean, professional look. 📋 Customizable Inputs: Add your name, profession, and location. Select your tech stack from a wide range of technologies. Include social media links (GitHub, LinkedIn, Twitter, Instagram, YouTube, Gmail, Portfolio). 📊 GitHub Stats: Optionally display GitHub stats, streak, and top languages. 🐍 Snake Animation: Add a fun contribution snake animation to your README. 🎨 Template Options: Choose between Simple and Professional README layouts. 💾 Downloadable README: Generate and download your README.md file with one click. 🔍 Real-Time Preview: See your README as you build it. 🛠️ Tech Stack
📌 Prerequisites Python 3.8 or higher 🐍 Streamlit (pip install streamlit) A GitHub account for stats integration (optional) 🛠️ Installation Clone the Repository: bash https://github.com/Quratulain-bilal/Gitup_profile-generator.git
streamlit run app.py Access the App: Open your browser and go to http://localhost:8501. 📖 Usage Enter Personal Details: Input your name, profession, and location. Select your tech stack from the multiselect dropdown. Add social media URLs (GitHub, LinkedIn, etc.). Customize GitHub Stats: Check boxes to include GitHub stats, streak, top languages, or snake animation. Choose a Template: Select either Simple or Professional for your README style. Generate and Download: Click Generate README 🎉 to create your README. Use the Download README 📄 button to save it as README.md. Preview: View a live preview of your README in the right column as you make changes. 📂 Project Structure text
Copy github-profile-generator/ ├── app.py # Main Streamlit application ├── requirements.txt # Project dependencies ├── README.md # This file
🤝 Contributing We welcome contributions! Here's how you can help:
Fork the Repository 🍴 Create a Feature Branch: bash
Copy git checkout -b feature/your-feature Commit Changes: bash
Copy git commit -m "Add your feature" Push to Your Fork: bash
Copy git push origin feature/your-feature Open a Pull Request 🔄 Please ensure your code follows the project's style guidelines and includes appropriate comments.
🐛 Reporting Issues Found a bug? Please open an issue on the GitHub Issues page with the following details:
Description of the bug 🐞 Steps to reproduce Expected behavior Screenshots (if applicable)
🙌 Acknowledgments Streamlit for the amazing framework. GitHub Readme Stats for stats visuals. Shields.io for badge icons. All contributors who make this project better! ❤️ ⭐ Star this repo if you find it helpful! Let's make GitHub profiles shine together thank you ! 🌟