|
| 1 | +# GitHub Profile README Builder 🚀 |
| 2 | + |
| 3 | +[](https://github.com/dev-ashishk/github-profile-builder/stargazers) |
| 4 | +[](https://github.com/dev-ashishk/github-profile-builder/network) |
| 5 | +[](https://github.com/dev-ashishk/github-profile-builder/issues) |
| 6 | +[](https://github.com/dev-ashishk/github-profile-builder/blob/main/LICENSE) |
| 7 | +[](https://github-profile-builder-dev-ashishk.vercel.app) |
| 8 | + |
| 9 | +Create beautiful, customizable GitHub profile READMEs with ease. No coding required! |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## ✨ Features |
| 14 | + |
| 15 | +- **Multiple Templates**: Choose from 6 professionally designed templates (Modern, Minimal, Creative, Developer, Professional, and Elegant) |
| 16 | +- **Real-time Preview**: See your changes instantly with a live markdown preview |
| 17 | +- **GitHub Integration**: Automatically fetch your GitHub stats, repositories, and contribution data |
| 18 | +- **Customizable Sections**: Add/remove sections like skills, projects, experience, education, and more |
| 19 | +- **Color Themes**: Personalize your profile with custom color schemes |
| 20 | +- **GitHub Stats**: Display your GitHub statistics, top languages, and contribution streak |
| 21 | +- **Contribution Graph**: Show your GitHub contribution activity with customizable themes |
| 22 | +- **Achievement Trophies**: Showcase your GitHub achievements with customizable trophy displays |
| 23 | +- **One-click Copy**: Copy the generated markdown with a single click |
| 24 | +- **Dark Mode Support**: Switch between light and dark themes for comfortable editing |
| 25 | +- **Responsive Design**: Works on desktop, tablet, and mobile devices |
| 26 | + |
| 27 | +## 🚀 Getting Started |
| 28 | + |
| 29 | +### Online Builder |
| 30 | + |
| 31 | +The easiest way to use GitHub Profile Builder is through our online tool: |
| 32 | + |
| 33 | +👉 [Open GitHub Profile Builder](https://dev-ashishk.github.io/github-profile-builder) |
| 34 | + |
| 35 | +### Local Development |
| 36 | + |
| 37 | +To run the project locally: |
| 38 | + |
| 39 | +\`\`\`bash |
| 40 | +# Clone the repository |
| 41 | +git clone https://github.com/dev-ashishk/github-profile-builder.git |
| 42 | + |
| 43 | +# Navigate to the project directory |
| 44 | +cd github-profile-builder |
| 45 | + |
| 46 | +# Install dependencies |
| 47 | +npm install |
| 48 | + |
| 49 | +# Start the development server |
| 50 | +npm run dev |
| 51 | +\`\`\` |
| 52 | + |
| 53 | +Open [http://localhost:3000](http://localhost:3000) in your browser to see the application. |
| 54 | + |
| 55 | +## 📝 How to Use |
| 56 | + |
| 57 | +1. **Enter Your Information**: Fill in your name, title, bio, and other details |
| 58 | +2. **Connect GitHub**: Enter your GitHub username to automatically fetch your stats |
| 59 | +3. **Customize Sections**: Add skills, projects, work experience, and more |
| 60 | +4. **Choose a Template**: Select from 6 beautiful templates |
| 61 | +5. **Personalize Colors**: Customize the color scheme to match your style |
| 62 | +6. **Preview & Copy**: Preview your profile and copy the generated markdown |
| 63 | +7. **Paste into GitHub**: Create a repository named after your GitHub username and paste the markdown into the README.md file |
| 64 | + |
| 65 | +## 🛠️ Technologies Used |
| 66 | + |
| 67 | +- [Next.js](https://nextjs.org/) - React framework |
| 68 | +- [React](https://reactjs.org/) - UI library |
| 69 | +- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework |
| 70 | +- [shadcn/ui](https://ui.shadcn.com/) - UI component library |
| 71 | +- [Vercel](https://vercel.com/) - Deployment platform |
| 72 | + |
| 73 | +## 📊 Analytics |
| 74 | + |
| 75 | +This project uses [Vercel Analytics](https://vercel.com/analytics) for privacy-friendly website analytics. No personal data is collected, and no cookies are used. |
| 76 | + |
| 77 | +## 🤝 Contributing |
| 78 | + |
| 79 | +Contributions are welcome! Please feel free to submit a Pull Request. |
| 80 | + |
| 81 | +1. Fork the repository |
| 82 | +2. Create your feature branch (`git checkout -b feature/amazing-feature`) |
| 83 | +3. Commit your changes (`git commit -m 'Add some amazing feature'`) |
| 84 | +4. Push to the branch (`git push origin feature/amazing-feature`) |
| 85 | +5. Open a Pull Request |
| 86 | + |
| 87 | +## 📄 License |
| 88 | + |
| 89 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 90 | + |
| 91 | +## 🙏 Acknowledgements |
| 92 | + |
| 93 | +- [GitHub README Stats](https://github.com/anuraghazra/github-readme-stats) |
| 94 | +- [GitHub Streak Stats](https://github.com/DenverCoder1/github-readme-streak-stats) |
| 95 | +- [GitHub Profile Trophy](https://github.com/ryo-ma/github-profile-trophy) |
| 96 | +- [GitHub Contribution Chart Generator](https://github.com/sallar/github-contributions-chart) |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +Made with ❤️ by [dev-ashishk](https://github.com/dev-ashishk) |
| 101 | + |
| 102 | +Keywords: GitHub profile, README generator, GitHub README, profile builder, GitHub stats, GitHub contribution graph, GitHub trophy, markdown generator, developer profile |
0 commit comments