Skip to content

Latest commit

 

History

History
143 lines (96 loc) · 8.16 KB

README.md

File metadata and controls

143 lines (96 loc) · 8.16 KB

About BadgeOS

Easily create badges and set up the steps and achievements users complete to earn them. Badges are Mozilla OBI compatible and sharable via Credly. Official website: BadgeOS.org.

Description

BadgeOS™ turns your WordPress site into an achievement and badging system. Your site's users complete steps, demonstrate skills and knowledge, and earn digital badges. Easily define the achievements, organize the badge requirements any way you like, and choose from and combine a range of assessment options to determine whether each task or requirement has been achieved.

Create badges and set up the achievements to earn them. Badges are Mozilla OBI compatible and sharable via Credly, the free web service for recognizing and displaying lifelong achievement.

BadgeOS is extremely powerful and infinitely extensible. Check out some of the out-of-the-box features:

Many ways to define achievements and give badges

  • Reviewed submissions
  • Auto-approving submissions
  • Nominations and review
  • Site activity (triggers based on commenting and logging in to your site)
  • Completing specific other achievements one or a specific number of times
  • Completing one, select or all achievements of a specific type
  • Point thresholds
  • Admin Given Badges
  • Community Activity (with the powerful BadgeOS Community Add-on)

Define an Unlimited Number of Achievement Types

  • Create as many types of achievement as you like
  • Name achievement types whatever you wish
  • Easily define how they relate to one another using the 'Required Steps' tool
  • Set default images for each achievement type or select unique images for every achievement item.

Sharable Badges with Credly Integration

  • Badges are Mozilla Open Badge (OBI) compatible through integration of the "Open Credit" API by Credly, the free web service for issuing, earning and sharing badges.
  • Connect your Credly account to your BadgeOS site and voila! You're using WordPress to issue "Open Badges" that can be displayed virtually anywhere.
  • Badges you create in BadgeOS automatically appear and update on Credly
  • Use Credly iOS app to issue badges you created on your WordPress site.
  • As badges are earned on WordPress, they can be automatically sent to Credly for easy sharing on Facebook, LinkedIn, Twitter, Mozilla Backpack, the earner's own web site, blog, or Credly profile.

'Required Steps' Manager

  • Simple yet powerful admin interface for defining the "Required Steps" for any badge or achievement.
  • Easily link together one or more triggers, steps or actions into the conditions needed to earn a badge or mark an achievement.
  • Extend the Required Steps options using the free BadgeOS Community Add-on

Reward User Progress

  • Issue badges for any combination of achievements
  • Award points for commenting, logging in, making submissions, completing tasks

View and Issue your BadgeOS badges via iOS Mobile App

  • Badges created in BadgeOS are immediately available on the Credly iOS mobile app (with free Credly integration enabled).
  • Create badges in WordPress, and then issue them from your iPhone!
  • BadgeOS badge earners can receive, accept, view and share their badges from the iOS app (with their profile set to receive badges via Credly).
  • Credly app's "ID Card" view essentially turns a BadgeOS badge into an "access pass" for face-to-face activities.

Earned Badges Widget

  • Shows logged in users what badges they have earned.
  • Set the parameters for the widget to decide how many recent badges to display.
  • Members can share their badges right from the widget to their Credly profile and off to their linked social networks or Mozilla Backpack.

Theme Agnostic & Shortcodes

  • BadgeOS works with just about any standard WordPress theme.
  • No special hooks or theme updates are needed.
  • Just activate BadgeOS and place the simple shortcode on any page or post
  • And you've got an engagement management system running on your WordPress site!

Submission and Nomination Review

  • Easily review submissions and nominations from members.
  • Approve or deny submissions with one click
  • Add comments to engage the member and elaborate on your decisions.
  • Optional notification emails inform you when people on your site have made submissions or nominated peers.

Extensibility and BadgeOS Add-ons

  • BadgeOS is designed to be a true operating system for turning any WordPress site into an engagement management application.
  • Built with expandability in mind to allow virtually anything to trigger and recognize achievement.
  • BadgeOS plans to continue to release a range of Add-ons to the plugin that enhance core functionality with specialized functions.
  • Check out some of the BadgeOS customizations we've already implemented to get a sense for what you might expect.

Stay Connected / Helpful Links

BadgeOS is made available by Credly, LLC. Here are some ways to stay connected and to see what else we are up to:

License Info

Credly, LLC licenses BadgeOS to you under the terms of the GNU Affero General Public License, version 3, as published by the Free Software Foundation.

There is NO WARRANTY for this software, express or implied, including the implied warranties of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License, version 3, at http://www.gnu.org/licenses/agpl-3.0.html for more details.

Installation

  1. Upload 'badgeos' to the '/wp-content/plugins/' directory of your WordPress installation
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Visit the BadgeOS menu to add Badges and set up new Achievement Types.
  4. Enter Credly credentials for the badge Issuer in the Credly Integration settings to enable badge sharing. (First get free account at Credly.com if you do not have one.)
  5. Visit the Help/Support section of the BadgeOS menu for shortcodes to turn any page or post on your site into a BadgeOS list of available achievements and badges.

Bugs & Feature Requests

Please open an Issue to report any bugs or feature requests.

Contributing

The BadgeOS team welcomes donations in the form of code contributions, add-ons, and shared love for what we’re doing. So spread the word and share back your innovations with the BadgeOS community.

So, you want to contribute? That's great! Patches are always welcome. Open an Issue and make a Pull Request.

  1. Open an Issue (or claim an open Issue).
  2. Fork BadgeOS.
  3. Create a branch (git checkout -b MyBadgeos).
  4. Commit your changes (git commit -am "Added the best feature ever!").
  5. Push to the branch (git push origin MyBadgeos).
  6. Open a Pull Request.
  7. Enjoy a refreshing beverage and wait.