/Sash

Sash! - An open platform for creating, maintaining and issuing badges.

Primary LanguageJavaScriptMIT LicenseMIT

Sash

Sash is a badge issuing & hosting service that follows the metadata format of the awesome Mozilla Open Badge Infrastructure project. Allows developers to stand up their own badging platform and integrate badge creation, issuing and displaying into their own products.

The Parts

In Sash everything is scoped to an Organization.

Creating Badges

Sash provides a simple CRUD interface for creating and managing your badges. Upon creation badges are given a unique slug based on their name. Use this slug url to issue badges from your application.

Issuing Badges

Here is the general workflow for issue a badge: A user on your platform fufills criteria for earning badge. Your system makes a POST request to the unique badge URL generated by Sash, described above, with your organization's API key and the login or email of the user in your system. side call to Sash with user login or email to issue badge. The User is automatically initialized in the system if they don't exist (unique by username and organization), and the badge is issued to them.

Displaying Badges

Sash provides a display API allows you to query out the badges for an individual User via JSON. By default badges are marked as 'unseen' by the User, this allows you to track which badges are new to the User and display a dialog to notify the user of a new badge. Sash also provides an API call for marking individual badges as seen.

Technology behind Sash

Sash is builting using Node.js & CoffeeScript, on top of the delightful Express.js framework. Sash uses MongoDB for the database.

Status

Sash is currently under active development. If you want to get involved contact us @ engineering@everfi.com!

License

Sash is released under the MIT License