Skip to content

Repository files navigation

🚀 GitHub Profile Generator

Create stunning GitHub profile READMEs in minutes with beautiful templates and smooth animations

React Framer Motion Vercel MIT License

✨ Features

  • 🎨 4 Beautiful Templates - Choose from Professional, Creative, Minimal, and Developer styles
  • Real-time Preview - See your README come to life as you type
  • 🛠️ Interactive Skill Selector - Easy-to-use skill categorization with search
  • 🎭 Smooth Animations - Elegant Framer Motion animations throughout
  • 📱 Fully Responsive - Works perfectly on all devices
  • 🎯 One-Click Export - Copy to clipboard or download as README.md
  • 🌟 Modern UI/UX - Glassmorphism design with beautiful gradients

🎯 Demo

Try it live →

GitHub Profile Generator Demo

🚀 Quick Start

Prerequisites

  • Node.js 16+
  • npm or yarn

Installation

  1. Clone the repository

    git clone https://github.com/ahmedEssyad/github-profile-generator.git
    cd github-profile-generator
  2. Install dependencies

    npm install
  3. Start the development server

    npm start
  4. Open your browser Navigate to http://localhost:3000

📦 Build for Production

npm run build

🎨 Templates

1. Professional 👔

Perfect for job seekers and enterprise developers

  • Clean, minimal design
  • Focus on experience and skills
  • Professional badge styling

2. Creative 🎨

Great for designers and creative developers

  • Colorful and expressive
  • Unique visual elements
  • Personality-driven content

3. Minimal ⚡

For developers who prefer simplicity

  • Ultra-clean design
  • Essential information only
  • Fast loading and readable

4. Developer 💻

Technical focus for open source contributors

  • GitHub stats integration
  • Detailed tech stack
  • Contribution highlights

🛠️ Technology Stack

  • Frontend: React 19, Framer Motion
  • Styling: CSS3 with Glassmorphism effects
  • Icons: Lucide React
  • Fonts: Google Fonts (Inter, JetBrains Mono)
  • Deployment: Vercel

📁 Project Structure

github-profile-generator/
├── public/
│   ├── index.html
│   └── manifest.json
├── src/
│   ├── components/
│   │   ├── AnimatedBackground.js
│   │   ├── LandingPage.js
│   │   ├── ProfileForm.js
│   │   ├── ProfilePreview.js
│   │   ├── SkillSelector.js
│   │   └── Toast.js
│   ├── utils/
│   │   └── readmeGenerator.js
│   ├── App.js
│   ├── App.css
│   ├── LandingPage.css
│   └── index.js
├── package.json
├── README.md
└── LICENSE

🤝 Contributing

We love contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/amazing-feature
  3. Commit your changes
    git commit -m 'Add some amazing feature'
  4. Push to the branch
    git push origin feature/amazing-feature
  5. Open a Pull Request

Contribution Ideas

  • 🎨 New profile templates
  • 🌍 Internationalization support
  • 📊 More GitHub stats integrations
  • 🎯 Additional skill categories
  • 🔧 Performance improvements
  • 📝 Documentation enhancements

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

📬 Contact

Ahmed Essyad - @ahmedEssyad

Project Link: https://github.com/ahmedEssyad/github-profile-generator

⭐ Show your support

Give a ⭐️ if this project helped you create an awesome GitHub profile!


Built with ❤️ by Ahmed Essyad

About

Create stunning GitHub profile READMEs in minutes with beautiful templates and smooth animations

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages