The plugin enables your October CMS projects to generate and serve badges as per the Shields badge specification. I originally designed this plugin just for kicks but found it useful enough that I discovered several places where I can use this, such as to show status messages, etc.
Demo
Note: These samples are linked to shields.io badges, you can use your own website URL too using the exposed RESTful API feature (see this plugin’s documentation).
Features
- Add badges in pages as a component, in dashboard as a widget or serve it via a RESTful API to any website.
- Track hits on badges via the RESTful API and pages.
- Override badge value to show useful data from backend such as website view count, users count, queue status, etc.
The following plugin is required
How to add this to your website
- Create a new badge from the badges page (Found under CMS category of the Backend Settings page).
- In the CMS page, find the component named
Badgeand drag it into the code of your page or layout where you would like the badge to appear. - In the added component's properties dropdown, select the badge which you would like to use. By default, the first available badge set should be selected.
Presto! You're all set and you can now see the badge in your web app!
How to use this in external site
The badge plugin exposes a RESTful API through which you can access badges you created. The URL format to view your badge is:
http://yourwebsite.com/api/v1/badges/<badge-id>
For example, you can use the markdown like this to use the badge anywhere in your own website or any external site like this:
| 1.0.3 |
Updated to the new REST API provider. Oct 12, 2019 |
|---|---|
| 1.0.2 |
Bug fix, added missing default values for report widget Oct 11, 2019 |
| 1.0.1 |
First version of Badges Dec 12, 2016 |