BadgeKit and Open Badges Resources

SueSmith edited this page Sep 29, 2014 · 13 revisions

This page details some of the many resources and utilities you may find helpful when working with BadgeKit and Open Badges generally. Some of these tools will not be relevant to you if you are using BadgeKit because it does lots of the work for you! However, you may find useful links below if you are building a badging system with the BadgeKit APIs or implementing anything within the Open Badges framework.

For introductory information about Open Badges: http://openbadges.org/

For information about BadgeKit: https://www.badgekit.org/

This list is a work in progress and will continue to be developed.

Contents

Issuers

Issuer Onboarding: https://github.com/mozilla/openbadges/wiki/Open-Badges-Onboarding:-Issuers

New Issuers - Give Yourself a Badge https://github.com/mozilla/openbadges/wiki/New-Issuers:-Give-Yourself-a-Badge

Issuer API (to let earners to add an issuer's badges to their Mozilla Backpack): https://github.com/mozilla/openbadges/wiki/Using-the-Issuer-API

Backpack Connect API (for managing persistent access to the Mozilla Backpack): https://github.com/mozilla/openbadges/wiki/Using-the-Backpack-Connect-API

Revoking issued badges: https://github.com/mozilla/openbadges/wiki/Revoking-Issued-Badges

Issuer Checklist: https://github.com/mozilla/openbadges/wiki/Issuer-Checklist

Using SVG Badges: https://github.com/mozilla/openbadges/wiki/Using-SVG-Badges

Building Badges

Have a go at building a badge using Badge Lab: https://badgelab.herokuapp.com/

Also see the tutorial: https://badgelab.herokuapp.com/tutorial/89163

Browse the Badge Lab source code: https://github.com/toolness/badgelab

Validation

Open Badges Metadata Validator: http://validator.openbadges.org/

Each badge is defined using an assertion. If you are using BadgeKit to define and design your badges, you may not need to build assertion data manually, although you will deal with the contained data items if you use the BadgeKit APIs to retrieve badge information. If you are building a system in which you need to define a badge assertion, save yourself and your team a potential headache and validate the data before you deploy it.

Source code for validator Web front-end: https://github.com/mozilla/openbadges-validator-service

You can also use the validator within your application code: https://github.com/mozilla/openbadges-validator

The assertion specification: https://github.com/mozilla/openbadges-specification/blob/master/Assertion/latest.md

...and assertion introduction: https://github.com/mozilla/openbadges/wiki/Assertion-Information-for-the-Uninitiated

Creating signed assertions: https://github.com/mozilla/openbadges/wiki/Creating-Signed-Assertions

Baking

Baked badges are image files with badge assertion data embedded in their metadata. If you use the Issuer API, it handles baking for you.

This command line tool is an Open Badges image baking library that works with PNGs and SVGs: https://github.com/mozilla/openbadges-bakery

The Web baker interface also bakes badges using the URL of a badge assertion: http://bakery.openbadges.org/

You can use the baker via the API: https://github.com/mozilla/openbadges/wiki/Badge-Baking

GitHub repo for Web front-end for the bakery tool: https://github.com/mozilla/openbadges-bakery-service

BadgeKit

BadgeKit Web app: https://github.com/mozilla/openbadges-badgekit

...it works in conjunction with the API: https://github.com/mozilla/badgekit-api

Check out the BadgeKit tutorial for an overview of using the hosted private beta version: https://github.com/mozilla/openbadges-badgekit/wiki/BadgeKit-Tutorial

See the API Introduction to see how you can build on top of BadgeKit: https://github.com/mozilla/openbadges-badgekit/wiki/BadgeKit-API-Introduction

The guide to using BadgeKit API takes you through the steps you need to get started accessing the API endpoints: https://github.com/mozilla/badgekit-api/wiki/Using-BadgeKit-API

Overview of how assessment works with BadgeKit: https://github.com/mozilla/openbadges-badgekit/wiki/Assessment-with-BadgeKit

If you want to create a self-hosted instance of BadgeKit, see the guide: https://github.com/mozilla/openbadges-badgekit/wiki/BadgeKit-Self-Hosting-Guide

If you're having trouble getting your own instance of BadgeKit working, see the troubleshooting guide: https://github.com/mozilla/openbadges-badgekit/wiki/Troubleshooting-BadgeKit

If you want to use the User API to manage BadgeKit user accounts, see the guide: https://github.com/mozilla/openbadges-badgekit/wiki/Badgekit-User-API

BadgeKit API Client for node.js: https://github.com/mozilla/badgekit-api-client

Watch our BadgeKit webinar trainings for a full walk-through of the tools: http://www.youtube.com/watch?v=gXhmMcXSysw http://www.youtube.com/watch?v=uvz-chEpi7Q

Get answers to some of the most frequently asked questions in the BadgeKit Help section: https://badgekit.org/help

Testing

Badge Test is a utility you can use to issue badges to the Backpack instance of your choosing: http://badgetest.herokuapp.com/

See the GitHub docs for more information: https://github.com/stenington/badgetest

...and the How To for instructions on using the tool: https://github.com/stenington/badgetest/wiki/How-To

Displayers

Displayer Onboarding: https://github.com/mozilla/openbadges/wiki/Open-Badges-Onboarding:-Displayers

The Mozilla Backpack includes the Displayer API for retrieving earner badges: https://github.com/mozilla/openbadges/wiki/Using-the-Displayer-API

The Open Badges Displayer script automates an interactive display of baked badges using only client-side code: https://github.com/cmcavoy/openbadges-displayer.js

Verifying

Tutorial on badge verification: https://github.com/mozilla/openbadges/wiki/Verifying-Badges-for-Display

Finding Badges

The Discover project: http://discover.openbadges.org/

...and source code: https://github.com/mozilla/openbadges-discovery

Open Badges directory: http://directory.openbadges.org/

... source code: https://github.com/mozilla/openbadges-directory

Open Badges Concepts

Get Started with Open Badges: https://github.com/mozilla/openbadges/wiki/Get-Started-with-Open-Badges

Open Badges FAQs: https://github.com/mozilla/openbadges/wiki/Open-Badges-FAQs

Open Badges and BadgeKit Glossary: https://github.com/mozilla/openbadges-badgekit/wiki/Glossary

Read the Open Badges blog to keep up with developments: http://openbadges.tumblr.com/

Backpack user tutorial: https://github.com/mozilla/openbadges/wiki/Share-your-Badges-with-the-Mozilla-Backpack

Getting Involved

You can get involved in the Open Badges projects in a number of ways (including through the GitHub repos listed above).

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.