Skip to content

A lightweight web app that lets you generate a stylish business card from any GitHub username or profile URL. You can download the card as a PDF , PNG or share it directly along with the GitHub link. Includes dark mode support!

Notifications You must be signed in to change notification settings

paulmagadi/GitHub-Business-Card-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Business Card Generator 🧑‍💻

A lightweight web app that lets you generate a stylish business card from any GitHub username or profile URL. You can download the card as a PDF , PNG or share it directly along with the GitHub link. Includes dark mode support!

Preview


🚀 Features

  • 🔍 Fetch GitHub profile data (name, avatar, bio, stats, etc.)
  • 📦 Calculate total public repositories and stars
  • 🌐 Generate a QR code linking to the GitHub profile
  • 📄 Download the business card as a PDF (via jsPDF)
  • 📄 Download the business card as a png (via html2canvas)
  • 📤 Share the card image + GitHub link (via Web Share API)
  • 🌙 Toggle between Light and Dark mode
  • 📱 Mobile-friendly layout

🔧 How It Works

  1. Enter a GitHub username or full profile URL.
  2. Click Generate Card.
  3. The app fetches profile data using the GitHub REST API.
  4. A visually styled business card is rendered.
  5. You can:
    • Click Download PDF or Click Download PNG to save it.
    • Click Share to send the card image and link.
    • Toggle between light/dark mode.

🛠️ Tech Stack


📷 Screenshots

Light Mode Dark Mode
light dark

📂 Project Structure

📁 github-business-card/
├── index.html # Main web page
├── style.css # Embedded CSS styles
├── script.js # JavaScript logic (if separated)
├── preview.png # Preview image for README
└── README.md # You're here!

📦 Installation

No installation required! Just open the index.html in your browser.


Deploy it with GitHub Pages:

git clone https://github.com/paulmagadi/github-business-card-generator.git
cd github-business-card

Then open index.html or host it.


📤 Share and Download Limitations

Sharing uses the Web Share API, which is supported on most modern mobile browsers.

If unsupported, the image is automatically downloaded instead.


🔒 Privacy & Limitations

The app only fetches public GitHub profile and repository data.

GitHub API rate limits may apply for unauthenticated requests (60/hour).


📃 License

MIT License. Use freely, modify, and share!

🙋‍♂️ Author

Paul Magadi 💼 LinkedIn 📂 Portfolio 💻 GitHub

⭐️ Support

If you find this useful, star the repo and share it with fellow devs!

About

A lightweight web app that lets you generate a stylish business card from any GitHub username or profile URL. You can download the card as a PDF , PNG or share it directly along with the GitHub link. Includes dark mode support!

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published