Skip to content

DXBMark/badge-builder

🎨 Badge Builder Pro

Generate your developer profile badges

A free tool to design and generate professional badges for developers, GitHub profiles, README files, CI status, coverage, tech stack, and personal or commercial branding.

React JavaScript Material UI SVG Vite MIT License Version Live Demo


πŸ”— Live Demo

πŸš€ Open Live Demo β†’

Live Demo


πŸ“Έ Preview

SVG Badge Builder Preview


✨ Features

Feature Status
Live SVG badge preview βœ…
Full control over badge dimensions (width, height, radius) βœ…
Left and right text customization βœ…
Independent font family and weight per section βœ…
Full color controls (backgrounds, text colors) βœ…
Gradient support with custom start/end colors βœ…
Icon presets (built-in library) βœ…
Custom SVG icon upload βœ…
Icon positioning and scaling βœ…
Rounded corners βœ…
Optional configurable outline/border βœ…
Copy generated SVG code βœ…
Download SVG file βœ…
Download PNG file βœ…
Copy README markdown snippet βœ…
Built-in badge presets βœ…
Build diagnostics panel (Shields.io standard checks) βœ…
Safe SVG text escaping and validation βœ…
Dark Mode support βœ…
Drag-and-drop text position editing βœ…

πŸ’‘ Product Nature

  • Static badge designer β€” Fully visual control over dimensions and colors
  • README badge generator β€” Perfect for GitHub profiles and documentation
  • GitHub badge snippet builder β€” Instant markdown and HTML code generation
  • Visual preset system β€” Built-in templates for GitHub, NPM, and Shields styles
  • Brand kit manager β€” Consistent branding for your developer identity
  • Icon-powered badge builder β€” Integrated icons and custom SVG support
  • Local-first tool β€” Your data stays in your browser (LocalStorage)

🎯 Use Cases

  • GitHub README badges β€” Status, version, and tech-stack indicators
  • Developer portfolios β€” Professional branding for your personal site
  • Project documentation β€” Consistent visual indicators across docs
  • CI/CD status & Coverage β€” Visual representation of project health
  • Personal & Commercial branding β€” Custom labels for products or teams

πŸš€ Getting Started

Prerequisites

Installation

git clone https://github.com/DXBMark/badge-builder.git
cd badge-builder
npm install
npm run dev

Open your browser at: http://localhost:5173


πŸ—οΈ Build for Production

npm run build

Output is placed in the dist/ directory.


☁️ Deployment

This project can be deployed to any static hosting platform:

Platform Command / Notes
GitHub Pages npm run build β†’ push dist/ via gh-pages
Vercel Connect repo β†’ auto-build on push
Netlify Connect repo β†’ build command: npm run build

πŸ“¦ Version

Current version: v1.0.0

See full history in CHANGELOG.md


πŸ—ΊοΈ Roadmap

Feature Status
Custom SVG icon upload βœ… Done
PNG export βœ… Done
Drag-and-drop text position editing βœ… Done
Saved custom presets βœ… Done
Theme presets (GitHub, NPM, Shields-style) βœ… Done
Dynamic badge API (generate via URL) πŸ”œ Planned
Embed generator (iframe widget) πŸ”œ Planned

🀝 Contributing

Contributions, issues, and feature requests are welcome!

  1. Fork the project
  2. Create your feature branch: git checkout -b feat/amazing-feature
  3. Commit your changes: git commit -m '[TS] Add: amazing feature'
  4. Push to the branch: git push origin feat/amazing-feature
  5. Open a Pull Request

⚠️ For major changes, please open an issue first to discuss what you would like to change.


πŸ‘€ Author

Created and maintained by Tariq Said


πŸ“„ License

This project is licensed under the MIT License β€” see the LICENSE file for details.


Built with ❀️ by Tariq Said

About

A powerful SVG Badge Builder with full visual control for creating custom GitHub README badges.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors