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.
Check out the live app here: Profile-X
- 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.
Once you've created your profile using Profile-X, follow these simple steps to add the generated markdown code to your GitHub profile:
-
Copy the Markdown Code: After customizing your profile in Profile-X, click the "Copy" button to copy the generated code to your clipboard.
-
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.
-
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.
-
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.
- Delete any existing content in the
-
Commit Changes:
- Scroll down and write a commit message (e.g., "Updated profile with Profile-X").
- Click the Commit changes button.
-
Enjoy Your Stunning Profile:
- Refresh your GitHub profile page, and you’ll see your new, customized profile in action!
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.
This project uses APIs and resources created by talented developers. Special thanks to:
- Anurag Hazra for github-readme-stats
- Jonah Lawrence for github-readme-streak-stats
- Ashutosh Dwivedi for github-readme-activity-graph
Profile-X was inspired by Daniel Cranney's ProfileMe.dev. A big shoutout to Daniel for the original idea and design!
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
If you liked the app, please consider giving it a star ⭐
Let your GitHub profile shine with Profile-X! ✨