https://github.com/shahvandit8/profile-x
A Github Profile Readme Generator, that lets you build stunning github profile readme in minutes. Customize you github profile at https://profilex.dev
https://github.com/shahvandit8/profile-x
gihub-profile-readme-builder github github-profile-builder github-profile-readme github-profile-readme-creator github-profile-readme-generator github-readme github-readme-profile githubprofile markdown markdown-editor profile-readme profile-readme-builder profile-readme-generator readme readme-md readme-md-generator readme-profile readme-profile-generator
Last synced: 3 months ago
JSON representation
A Github Profile Readme Generator, that lets you build stunning github profile readme in minutes. Customize you github profile at https://profilex.dev
- Host: GitHub
- URL: https://github.com/shahvandit8/profile-x
- Owner: ShahVandit8
- Created: 2024-02-12T20:19:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T17:30:30.000Z (4 months ago)
- Last Synced: 2025-02-28T21:56:07.796Z (4 months ago)
- Topics: gihub-profile-readme-builder, github, github-profile-builder, github-profile-readme, github-profile-readme-creator, github-profile-readme-generator, github-readme, github-readme-profile, githubprofile, markdown, markdown-editor, profile-readme, profile-readme-builder, profile-readme-generator, readme, readme-md, readme-md-generator, readme-profile, readme-profile-generator
- Language: JavaScript
- Homepage: http://profilex.dev
- Size: 5.86 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Profile-X 🚀
Create a stunning GitHub profile in minutes! Profile-X is a web app that helps you generate a customized `README.md` for your GitHub profile, showcasing your skills, experience, and projects. With an intuitive interface, you can easily build a professional and visually appealing profile.
---
## 🌟 Live Link
Check out the live app here: [Profile-X](https://profilex.dev/)
---
## ✨ Features
- **Introduction Section**: Add basic information, portfolio links, and notable projects.
- **Skills Icons**: Choose from **60+ technologies and software icons** to showcase your expertise.
- **Social Links**: Include links to **17 social media platforms** to connect with your audience.
- **Badges and Statistics**: Add graphic elements like GitHub stats badges, Twitter follow button, and Twitch streaming status.
- **Support Links**: Link to support platforms like **BuyMeACoffee**.
- **Customizable README.md**: Generate and copy a fully customized `README.md` file for your GitHub profile.
---
## 📝 Adding Your Profile to GitHub
Once you've created your profile using Profile-X, follow these simple steps to add the generated markdown code to your GitHub profile:
1. **Copy the Markdown Code**: After customizing your profile in Profile-X, click the "Copy" button to copy the generated code to your clipboard.
2. **Go to Your GitHub Profile**:
- Log in to your GitHub account.
- Click on your profile picture in the top-right corner and select **Your profile**.
3. **Create/Edit Your `README.md`**:
- On your profile page, click the **Edit profile** button (pencil icon).
- If you don’t already have a `README.md` file, GitHub will prompt you to create one. Click **Create a new README**.
- If you already have a `README.md`, simply click the edit (pencil) button.
4. **Paste the Markdown Code**:
- Delete any existing content in the `README.md` file.
- Paste the markdown code you copied from Profile-X into the editor.
5. **Commit Changes**:
- Scroll down and write a commit message (e.g., "Updated profile with Profile-X").
- Click the **Commit changes** button.
6. **Enjoy Your Stunning Profile**:
- Refresh your GitHub profile page, and you’ll see your new, customized profile in action!
---
## 🛠️ Technologies Used
Here are the languages, frameworks, and tools used to build Profile-X:
- **Frontend**: React.js, JavaScript.
- **Styling**: Bootstrap, CSS.
- **Version Control**: Git, GitHub.
- **Deployment**: Vercel.
---
## 🙏 Credits
This project uses APIs and resources created by talented developers. Special thanks to:
- **Anurag Hazra** for [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
- **Jonah Lawrence** for [github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats)
- **Ashutosh Dwivedi** for [github-readme-activity-graph](https://github.com/Ashutosh00710/github-readme-activity-graph)
---
## 💡 Inspiration
Profile-X was inspired by Daniel Cranney's ProfileMe.dev. A big shoutout to Daniel for the original idea and design!
---
## 🤝 Contributing
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
---
Made with ❤️ and ☕ by [Vandit Shah](https://github.com/ShahVandit8)
If you liked the app, please consider giving it a star ⭐
Let your GitHub profile shine with **Profile-X**! ✨