badgen.net/README.md

Badgen Service

Home of badgen.net, fast badge generating service.

Badgen is

• Written in latest, vanilla JavaScript => no build process
• Using badgen library to generate svg on the fly => fast & stateless
• Hosted on Now, serving behind Now CDN => faster & reliable
• Cache less than 4 minutes => fresh & hot
• Three endpoints in one server
  • https://badgen.net - classic style badges
  • https://flat.badgen.net - flat & square style badges
  • https://api.badgen.net - json “style” badges data (live badges only)
• Two badge types
  • static badge - url defined badge (subject, status, color)
  • live badge - show live status from 3rd party services
• Builtin Icons
  • Every icon is optimized with svgomg & reviewed by human eyes before it’s available online.

Developing

We are using StandardJS style, make sure you have ESLint/Standard plugin on your editor and have autofix enabled.

Add live badge

If a service you wish to have is still missing here, we welcome new contirbutions. Basically, you need to add a file in libs/live-fns/[name-of-service].js and that's it. Take crates as an example:

• libs/live-fns/crates.js - the main function for crates.io
• libs/live-fns/_index.js - the index of live-badges
• libs/index.md - the index.md holds examples

To ensure that your addition is working correctly start the development server with npm run dev.

Add icon

Badgen Server will auto load all svg files in libs/icons. Please make sure new icon is optimized using svgomg.

Deploy to Now

Badgen generate badges on the fly, which means it's stateless (not rely on any db service). Deploy your own Badgen Service to Now with one single command:

now amio/badgen-service -e GH_TOKEN=''

GH_TOKEN is required by Now deployment, but it's optional for Badgen (mostly, except some github badges :P).

About

Made with ❤️ by Amio, built with ⚡️ from badgen.