Skip to content

PhyoeBlitz/badge-generate

Repository files navigation

🎯 Hexagon Badge Generator

A React TypeScript application that generates hexagon-shaped skill badges from SkillIcons URLs and downloads them as individual PNG files with transparent backgrounds in a ZIP archive.

✨ Features

  • πŸ”· Hexagon Badge Generation: Creates beautiful hexagon-shaped badges with technology colors
  • πŸ“¦ PNG Zip Download: Downloads all badges as individual PNG files in a ZIP archive
  • 🎨 Transparent Background: PNG files have transparent backgrounds for versatile usage
  • 🎨 Technology Colors: Supports 50+ technologies with authentic brand colors
  • πŸ“± Responsive Design: Works perfectly on desktop and mobile devices
  • ⚑ TypeScript: Built with type safety and modern React patterns
  • πŸš€ GitHub Pages: Automatically deployed via GitHub Actions

🌐 Live Demo

Visit the live application: https://PhyoeBlitz.github.io/badge-generate/

πŸš€ Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/PhyoeBlitz/badge-generate.git
cd badge-generate
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open your browser and navigate to http://localhost:5173/badge-generate/

πŸ“– Usage

  1. Enter a SkillIcons URL in the input field (e.g., https://skillicons.dev/icons?i=ts,react,python,aws)
  2. Click "Generate Hexagon Badges" to create the badges
  3. Click "Save All as PNG Zip" to download all badges as individual PNG files with transparent backgrounds

πŸ’‘ Example URLs

  • Single Icon: https://skillicons.dev/icons?i=ts
  • Frontend Stack: https://skillicons.dev/icons?i=js,ts,react,vue
  • Python Stack: https://skillicons.dev/icons?i=python,django,flask,fastapi
  • DevOps Stack: https://skillicons.dev/icons?i=aws,docker,kubernetes,jenkins
  • Full Stack: https://skillicons.dev/icons?i=html,css,js,php,mysql

πŸ› οΈ Technology Stack

  • βš›οΈ React 18 - Modern UI library with hooks
  • πŸ”· TypeScript - Type safety and better development experience
  • ⚑ Vite - Fast build tool and development server
  • πŸ“¦ JSZip - Client-side ZIP file creation
  • 🎨 CSS3 - Advanced styling with hexagon clip-path
  • πŸ”„ GitHub Actions - Automated deployment to GitHub Pages

🎯 Supported Technologies

The app supports 50+ technologies including:

  • Frontend: TypeScript, JavaScript, React, Vue, Angular
  • Backend: Python, Java, PHP, Go, Rust, Node.js
  • Cloud: AWS, Docker, Kubernetes, Jenkins
  • Databases: MySQL, PostgreSQL, MongoDB, Redis
  • Tools: Git, GitHub, GitLab, VS Code, Figma

✨ Key Features

  • 🎨 Authentic Colors: Each technology badge uses official brand colors
  • πŸ” High Resolution: 2x scale PNG output for crisp quality at any size
  • πŸ”· Perfect Hexagons: CSS clip-path creates perfect geometric shapes
  • ✨ Hover Effects: Interactive animations and scaling on hover
  • πŸ“± Mobile Responsive: Seamlessly adapts to different screen sizes
  • 🌟 Transparent PNGs: Perfect for overlaying on any background
  • ⚑ Fast Performance: Client-side processing with no server dependencies

πŸš€ Deployment

This project is automatically deployed to GitHub Pages using GitHub Actions. Every push to the main branch triggers:

  1. Build Process: Compiles TypeScript and bundles assets
  2. Optimization: Minifies code and optimizes images
  3. Deployment: Automatically publishes to GitHub Pages

πŸ“œ Scripts

  • npm run dev - Start development server with hot reload
  • npm run build - Build optimized production bundle
  • npm run preview - Preview production build locally
  • npm run lint - Run ESLint for code quality checks

🀝 Contributing

  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

πŸ™ Acknowledgments

This project is powered by SkillIcons - an amazing service that provides beautiful tech stack icons. Special thanks to:

  • SkillIcons by @tandpfun - For providing the awesome skill icons API
  • Technology Communities - For creating and maintaining the iconic logos and brand colors

πŸ“ License

This project is open source and available under the GPL-3.0 license.


Built with ❀️ by PhyoeBlitz

Sponsor this project