Concise, consistent, and legible badges in SVG and raster format
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Add some basic frontend tests (#2490) Dec 10, 2018
.github Give the NPM package some love (#2200) Oct 30, 2018
__snapshots__ Precompute text width using a lookup table (#2311) Nov 15, 2018
doc [Wheelmap] service rewrite and tests (#2486) Dec 10, 2018
frontend Add some basic frontend tests (#2490) Dec 10, 2018
gh-badges Prevent bad letter spacing when whitespace surrounds badge text (#2475) Dec 8, 2018
lib Minor test updates for jenkins coverage and token-pool (#2509) Dec 11, 2018
logo Add Azure DevOps logo (#2463) Dec 11, 2018
pages Refactor frontend main page and badge-example code (#2441) Dec 8, 2018
public Add monitoring platform Dec 3, 2017
scripts [Wheelmap] service rewrite and tests (#2486) Dec 10, 2018
services Fix [npm] badges when a dependency points to a URL (#2525) Dec 13, 2018
spec fix inline image path (#1427) Jan 6, 2018
static Website: Tweak footer and usage (#2285) Nov 9, 2018
test-fixtures Add some error messages for the developer when .service.js is malform… Oct 28, 2018
.buildpacks Node engine version information. Deployment files. Jan 3, 2014
.dockerignore Improve Docker run (envsubst, Alpine, documented env file) (#870) May 7, 2017
.editorconfig .editorconfig file to help all contributers to align to a common proj… Nov 5, 2015
.eslintignore Add snapshot tests for SVG and JSON (#1557) Mar 11, 2018
.eslintrc-frontend.yml Refactor frontend main page and badge-example code (#2441) Dec 8, 2018
.eslintrc.yml Enforce using async-await [f-droid] (#2241) Nov 4, 2018
.gitignore Service definition export format (#2397) Dec 2, 2018
.nycrc.json Coverage: ignore next.config (#2358) Nov 18, 2018
.prettierignore Rewrite server deploy script (#1793) Oct 30, 2018
.prettierrc.yml Turn on prettier (except repo root) (#1167) Aug 8, 2018
CONTRIBUTING.md Precommit hook with Prettier and ESLint (#2178) Oct 19, 2018
Dockerfile Revert to standard CI image and remove lingering references to fonts (#… Nov 18, 2018
LICENSE License's content and filename changed (#2146) Oct 5, 2018
Makefile Revert to standard CI image and remove lingering references to fonts (#… Nov 18, 2018
Procfile [Wheelmap] service rewrite and tests (#2486) Dec 10, 2018
README.md Readme: Update badge label (#2372) Nov 21, 2018
app.json [Wheelmap] service rewrite and tests (#2486) Dec 10, 2018
dangerfile.js Updated Danger server guideline (#2467) Dec 6, 2018
favicon.png favicon.png recompress with zopflipng losslessly Mar 12, 2016
next.config.js Refactor frontend main page and badge-example code (#2441) Dec 8, 2018
now.json Move NPM package files out of /lib ; affects [resharper nuget myget d… Nov 15, 2018
package-lock.json Remove unused wait-promise dep (#2521) Dec 13, 2018
package.json Remove unused wait-promise dep (#2521) Dec 13, 2018
secret.tpl.json [Wheelmap] service rewrite and tests (#2486) Dec 10, 2018
server.js Rewrite [DynamicXml] and [DynamicYaml] badges (#2487) Dec 12, 2018
server.spec.js Refactor cache-header handling and config, create NonMemoryCachingBas… Dec 1, 2018
shields.example.env Redirect the root only when configured (#1270) Nov 17, 2017

README.md

build status service-test status coverage commits to be deployed Total alerts chat on Discord follow on Twitter

This is home to Shields.io, a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. Every month it serves over 470 million images.

This repo hosts:

Examples

  • code coverage percentage: coverage
  • stable release version: version
  • package manager release: gem
  • status of third-party dependencies: dependencies
  • static code analysis grade: codacy
  • SemVer version observance: semver
  • amount of Liberapay donations per week: receives
  • Python package downloads: downloads
  • Chrome Web Store extension rating: rating
  • Uptime Robot percentage: uptime

Make your own badges! (Quick example: https://img.shields.io/badge/left-right-f39f37.svg)

Browse a complete list of badges.

Contributing

Shields is a community project. We invite your participation through issues and pull requests! You can peruse the contributing guidelines.

When adding or changing a service please add tests.

This project has quite a backlog of suggestions! If you're new to the project, maybe you'd like to open a pull request to address one of them:

GitHub issues by-label

You can read a tutorial on how to add a badge.

Development

  1. Install Node 8 or later. You can use the package manager of your choice. Tests need to pass in Node 8 and 9.
  2. Clone this repository.
  3. Run npm install to install the dependencies.
  4. Run npm run build to build the frontend.
  5. Run npm start to start the server.
  6. Open http://[::]:8080/ to view the home page.

To generate the frontend using production cache settings – that is, badge preview URIs with maxAge – run LONG_CACHE=true npm run build.

To analyze the frontend bundle, run npm install webpack-bundle-analyzer and then ANALYZE=true npm start.

Snapshot tests ensure we don't inadvertently make changes that affect the SVG or JSON output. When deliberately changing the output, run SNAPSHOT_DRY=1 npm run test:js:server to preview changes to the saved snapshots, and SNAPSHOT_UPDATE=1 npm run test:js:server to update them.

The server can be configured to use Sentry (configuration) and Prometheus (configuration).

Daily tests, including a full run of the service tests and overall code coverage, are run via badges/daily-tests.

Hosting your own server

There is documentation about hosting your own server.

History

b.adge.me was the original website for this service. Heroku back then had a thing which made it hard to use a toplevel domain with it, hence the odd domain. It used code developed in 2013 from a library called gh-badges, both developed by Thaddée Tyl. The project merged with shields.io by making it use the b.adge.me code and closed b.adge.me.

The original badge specification was developed in 2013 by Olivier Lacan. It was inspired by the Travis CI and similar badges (there were a lot fewer, back then). In 2014 Thaddée Tyl redesigned it with help from a Travis CI employee and convinced everyone to switch to it. The old design is what today is called the plastic style; the new one is the flat style.

You can read more about the project's inception, the motivation of the SVG badge specification, and the specification itself.

Project leaders

espadrine is the sysadmin.

These contributors donate time on a consistent basis to help guide and maintain the project:

Related projects

License

All assets and code are under the CC0 LICENSE and in the public domain unless specified otherwise.

The assets in logo/ are trademarks of their respective companies and are under their terms and license.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]