Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Mozilla Open Badges Backpack
JavaScript CSS Other

2.0.3

latest commit d6e6cf7037
@cmcavoy cmcavoy authored
Failed to load latest commit information.
acceptance-test added docs for sauce labs.
bin Use messina module
check fix spelling
controllers Merge pull request #1004 from WeAreFarmGeek/development
docs Update issuer_api.md
fakeissuer Add IE8 support to fakeissuer.
lib Merge pull request #1004 from WeAreFarmGeek/development
migrations Add `baked` field for images
models Don't assume the badge is a PNG
scripts Add a basic nagios check against the backer API
static Merge pull request #829 from arasbm/development
test Merge pull request #1004 from WeAreFarmGeek/development
var Initial migration, starting to write the BrowserID stuff.
views Merge pull request #1004 from WeAreFarmGeek/development
.gitignore Merge pull request #952 from stenington/docs
.gitmodules Twitter bootstrap has moved from github user twitter to twbs
.jshintrc Style consistency; less noisy tests; new default make task.
.travis.yml And set DISABLE_PHANTOM_TESTS for travis
LICENSE Add a LICENSE file stating we're using MPL 2.0
Makefile Merge branch 'development' into 503-spec-implementation
Procfile adding .idea to .gitignore for jetbrains users
README.md removed vagrant instructions
app.js Don't assume the badge is a PNG
middleware.js Let whitelisted pages generate CSRF tokens
package.json 2.0.3

README.md

Mozilla Open Badges Backpack

Build Status

This is the Mozilla Hosted Backpack for earners' Open Badges. The Backpack allows earners to collect and manage their badges in groups, choosing whether each group is public or not. You can access the Mozilla Backpack Web front-end at: http://backpack.openbadges.org

The Backpack code includes tools for badge issuers and displayers, for pushing awarded badges to an earner's Mozilla Backpack and for retrieving an earner's badges for display.

Open Badges Specifications

To work with the Mozilla Backpack as either an issuer or a displayer, you will be handling Open Badge assertions, structured as JSON data according to the specification. See the specification repo for a detailed overview and Assertion Information for the Uninitiated for an introduction.

For more information about Open Badges, check out http://openbadges.org

I'm an Issuer, how do I use this?

The Backpack includes the following tools for badge issuers:

  • Issuer API
    • For pushing badges you have awarded the earner to their Mozilla Backpack, giving the earner the ability to approve the push through a lightboxed modal. The API is written in Javascript, and is includable in your project with just a few lines of JS.
  • Backpack Connect API
    • For pushing to the earner's Mozilla Backpack via persistent access, with permission granted by the earner.
  • Baker API
    • For embedding badge metadata into the badge image (not required if you use the Issuer API).

Requirements:

  • Webserver capable of serving requests to the general internet.
  • Ability to make a POST request from your server backend and read a JSON response.
  • Email addresses of the users you wish to issue badges.
  • Badge image must be in PNG format.

I'm a Displayer, how do I use this?

The Backpack includes the Displayer API, via which badge displayers can retrieve earner badges from their Mozilla Backpack. You will only be able to retrieve badges that the earner has chosen to make public. Given the earner email address, you can first use the conversion service to retrieve the earner's Backpack ID, then use that ID to query for public badge groups. Each group contains a list of badges awarded to the earner, inclding the information you need to present the badges within your site, application or other display implementation.

I want to play with the code, where do I start?

Creating a development environment

  1. Setup a MySQL database. Create a database and a user with full privileges on that db. For example:

    CREATE DATABASE openbadges;
    GRANT ALL PRIVILEGES ON openbadges.* TO badgemaker@localhost IDENTIFIED BY 'secret';
    CREATE DATABASE test_openbadges;
    GRANT ALL PRIVILEGES ON test_openbadges.* to badgemaker@localhost IDENTIFIED BY 'secret';
    
  2. Copy the openbadges/lib/environments/local-dist.js to openbadges/lib/environments/local.js and edit the configuration to match your local development environment. The MySQL database credentials should match step #1. For example:

    database: {
      driver: 'mysql',
      host: '127.0.0.1',
      user: 'badgemaker',
      password: 'secret',
      database: 'openbadges'
    },
    
  3. Install external tools:

    • PhantomJS: We use PhantomJS for running unit tests. On a debian based Linux system you can run sudo apt-get install phantomjs to install and run phantomjs --version to check it is installed. For other systems you can try downloading and installing it or building it from source.
  4. Install local dependencies: npm install

  5. Install submodules: git submodule update --init

  6. Run the test suite: npm test

  7. Start your server: npm start

No matter which way you choose, you should join the Open Badges Google Group. If you have any problems setting up the environment, feel free to post a message to the list.

Optional: A real hostname

I like to be able to use http://openbadges.local for accessing the project. Assuming you used vagrant, you can change the hostname in local.js and do sudo echo "33.33.33.11 openbadges.local" >> /etc/hosts to make it happen. If you're on OS X, you can also use Gas Mask for temporary hosts file switching rather than having to manually edit /etc/hosts

Database Migrations

If you need to modify the database schema, you'll want to create a migration. You can do this as follows:

  1. Come up with an alphanumeric name for your migration, e.g. add-issuer-column.

  2. Run ./bin/db-migrate create add-issuer-column. This will create a new JS file preixed with a timestamp in the migrations directory. Something like the following should be displayed:

    [INFO] Created migration at
    migrations/20130213205310-add-issuer-column.js

  3. Edit the new JS file as per the node-db-migrate instructions.

  4. Try out your migration using ./bin/db-migrate up.

  5. Try rolling back your migration using ./bin/db-migrate down.

And finally, note that during development, npm start automatically runs ./bin/db-migrate up for you. For production use, you'll need to manually run this command yourself whenever you deploy changes that involve a schema change.

If you want to write tests for your migration, check out test/migration.test.js for inspiration.

Production

The codebase behaves slightly differently when run in an environment where environment variable NODE_ENV=production. These differences include:

  • less verbose logging
  • using precompiled templates for client-side rendering
    • run bin/template-precompile to generate
  • "Test Site" banner will not show in the UI
Something went wrong with that request. Please try again.