• This repository has been archived on 22/Aug/2019
  • Stars
    star
    861
  • Rank 52,968 (Top 2 %)
  • Language
    JavaScript
  • License
    Other
  • Created over 13 years ago
  • Updated over 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Mozilla Open Badges Backpack

We are retiring the Mozilla Backpack and transitioning to Badgr Backpack. More information at https://backpack.openbadges.org.badgr.io/

Open Badges Backpack-ng (Next Generation)

Build Status Dependencies

Welcome to the future of the Backpack

Backpack-ng (pronounced 'backpacking') is the next generation of the Backpack.

Our team has been slugging away behind the scenes to ensure the Backpack stays relevant, maintained and loved.

The ng branch is currently where all the heavy development has been taking place. It's where the following changes have been introduced:

  • Updated the framework and most of the dependencies
  • Removed Persona as the main authentication mechanism (which is due to be decommissioned on the 31st Nov 2016)
  • Replaced Persona with PassportJS (which includes a Persona strategy/plugin to allow users to login with Persona until it is finally decommissioned).
  • Added a new responsive theme

Although we've given the backpack a bit of a facelift, there are still some rough edges to smooth out. The front-end functionality is working as expected (that is, to say, we haven't spotted anything that is majorly broken!). We're currently focusing our attention on the few remaining unit tests that are still failing (these mostly relate to the Backpack API).

Call to action!

If you feel you have something to offer and would like to help develop/design the backpack and push things forward, please feel free to grab the codebase and start hacking. Full setup instructions are below.

We welcome active collaborators, whether you want to discuss contributions to the code base or explore future developments, connect with us at [email protected]

What is the Backpack?

The Mozilla Backpack is a placed to store your collections of Open Badges. The Backpack allows earners to import badges and manage them 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. If you're an issuer or displayer, you will find more information on how to start interacting with the Backpack at the bottom of this guide.


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 openbadges_test.* 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 some 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.
  1. Install local dependencies: npm install

  2. Run the test suite: npm test

  3. 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

Heroku

Heroku relies upon the habitat environment variables loader library. The config for this can be found in lib/environments/heroku.js.

When configuring your environment variables on heroku, they should be prefixed with the string that is passed to the habitat constructor. For example, if we pass the string "openbadges" to our habitat constructor, like so: new Habitat("openbadges"), then in heroku our protocol env var would be "OPENBADGES_PROTOCOL" (with, in this case, a value set to either http or https).

Currently, the heroku env var config looks like so...

ENV VAR VALUE EXAMPLE
NODE_ENV "heroku"
OPENBADGES_ADMINS "['[email protected]','[email protected]']"
OPENBADGES_BADGE_PATH "static/_badges"
OPENBADGES_DATABASE_DATABASE "openbadges"
OPENBADGES_DATABASE_DRIVER "mysql"
OPENBADGES_DATABASE_HOST "eu-cdbr-west-01.cleardb.com"
OPENBADGES_DATABASE_PASSWORD "pa55w0rd"
OPENBADGES_DATABASE_USER "user"
OPENBADGES_FORCE_HTTPS true
OPENBADGES_HOSTNAME "backpack-ng.herokuapp.com"
OPENBADGES_IDENTITY_PATH "/verify"
OPENBADGES_IDENTITY_PROTOCOL "https"
OPENBADGES_IDENTITY_SERVER "verifier.login.persona.org"
OPENBADGES_LESS_COMPRESS true
OPENBADGES_LESS_ONCE true
OPENBADGES_NEW_RELIC false
OPENBADGES_NUNJUCKS_PRECOMPILED true
OPENBADGES_PROTOCOL "https"
OPENBADGES_REMOTE_PORT "default"
OPENBADGES_VAR_PATH "var"
OPENBADGES_MAILER_SERVICE "mailgun"
OPENBADGES_MAILER_USER "mailUser"
OPENBADGES_MAILER_PASS "mailPa55word"

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.

More Repositories

1

pdf.js

PDF Reader in JavaScript
JavaScript
43,965
star
2

DeepSpeech

DeepSpeech is an open source embedded (offline, on-device) speech-to-text engine which can run in real time on devices ranging from a Raspberry Pi 4 to high power GPU servers.
C++
25,096
star
3

send

Simple, private file sharing from the makers of Firefox
FreeMarker
13,234
star
4

sops

Simple and flexible tool for managing secrets
Go
12,778
star
5

BrowserQuest

A HTML5/JavaScript multiplayer game experiment
JavaScript
9,167
star
6

nunjucks

A powerful templating engine with inheritance, asynchronous control, and more (jinja2 inspired)
JavaScript
8,570
star
7

geckodriver

WebDriver for Firefox
7,166
star
8

TTS

πŸ€– πŸ’¬ Deep learning for Text to Speech (Discussion forum: https://discourse.mozilla.org/c/tts)
Jupyter Notebook
6,749
star
9

readability

A standalone version of the readability lib
JavaScript
6,470
star
10

sccache

Sccache is a ccache-like tool. It is used as a compiler wrapper and avoids compilation when possible. Sccache has the capability to utilize caching in remote storage environments, including various cloud storage options, or alternatively, in local storage.
Rust
5,763
star
11

mozjpeg

Improved JPEG encoder.
C
5,216
star
12

Fira

Mozilla's new typeface, used in Firefox OS
CSS
4,920
star
13

rhino

Rhino is an open-source implementation of JavaScript written entirely in Java
JavaScript
4,138
star
14

shumway

Shumway is a Flash VM and runtime written in JavaScript
TypeScript
3,692
star
15

source-map

Consume and generate source maps.
JavaScript
3,556
star
16

gecko-dev

Read-only Git mirror of the Mercurial gecko repositories at https://hg.mozilla.org. How to contribute: https://firefox-source-docs.mozilla.org/contributing/contribution_quickref.html
2,897
star
17

multi-account-containers

Firefox Multi-Account Containers lets you keep parts of your online life separated into color-coded tabs that preserve your privacy. Cookies are separated by container, allowing you to use the web with multiple identities or accounts simultaneously.
JavaScript
2,718
star
18

web-ext

A command line tool to help build, run, and test web extensions
JavaScript
2,695
star
19

bleach

Bleach is an allowed-list-based HTML sanitizing library that escapes or strips markup and attributes
Python
2,651
star
20

node-convict

Featureful configuration management library for Node.js
JavaScript
2,334
star
21

cbindgen

A project for generating C bindings from Rust code
Rust
2,314
star
22

MozDef

DEPRECATED - MozDef: Mozilla Enterprise Defense Platform
Python
2,166
star
23

popcorn-js

The HTML5 Media Framework. (Unmaintained. See https://github.com/menismu/popcorn-js for activity)
JavaScript
2,148
star
24

webextension-polyfill

A lightweight polyfill library for Promise-based WebExtension APIs in Chrome
JavaScript
2,088
star
25

fathom

A framework for extracting meaning from web pages
JavaScript
1,969
star
26

cipherscan

A very simple way to find out which SSL ciphersuites are supported by a target.
Python
1,912
star
27

hawk

HTTP Holder-Of-Key Authentication Scheme
JavaScript
1,903
star
28

neqo

Neqo, the Mozilla Firefox implementation of QUIC in Rust
Rust
1,828
star
29

persona

Persona is a secure, distributed, and easy to use identification system.
JavaScript
1,828
star
30

http-observatory

Mozilla HTTP Observatory
Python
1,784
star
31

uniffi-rs

a multi-language bindings generator for rust
Rust
1,783
star
32

mentat

UNMAINTAINED A persistent, relational store inspired by Datomic and DataScript.
Rust
1,650
star
33

task.js

Beautiful concurrency for JavaScript
JavaScript
1,635
star
34

hubs

Duck-themed multi-user virtual spaces in WebVR. Built with A-Frame.
JavaScript
1,561
star
35

fx-private-relay

Keep your email safe from hackers and trackers. Make an email alias with 1 click, and keep your address to yourself.
Python
1,473
star
36

pontoon

Mozilla's Localization Platform
Python
1,463
star
37

thimble.mozilla.org

UPDATE: This project is no longer maintained. Please check out Glitch.com instead.
JavaScript
1,423
star
38

kitsune

Platform for Mozilla Support
Python
1,289
star
39

mig

Distributed & real time digital forensics at the speed of the cloud
Go
1,195
star
40

grcov

Rust tool to collect and aggregate code coverage data for multiple source files
Rust
1,184
star
41

bedrock

Making mozilla.org awesome, one pebble at a time
HTML
1,176
star
42

OpenWPM

A web privacy measurement framework
Python
1,150
star
43

policy-templates

Policy Templates for Firefox
1,138
star
44

server-side-tls

Server side TLS Tools
HTML
1,114
star
45

rust-android-gradle

Kotlin
989
star
46

contain-facebook

Facebook Container isolates your Facebook activity from the rest of your web activity in order to prevent Facebook from tracking you outside of the Facebook website via third party cookies.
JavaScript
975
star
47

pdfjs-dist

Generic build of PDF.js library.
JavaScript
952
star
48

narcissus

INACTIVE - http://mzl.la/ghe-archive - The Narcissus meta-circular JavaScript interpreter
JavaScript
901
star
49

addons-server

πŸ•Ά addons.mozilla.org Django app and API πŸŽ‰
Python
833
star
50

awsbox

INACTIVE - http://mzl.la/ghe-archive - A featherweight PaaS on top of Amazon EC2 for deploying node apps
JavaScript
811
star
51

dxr

DEPRECATED - Powerful search for large codebases
Python
804
star
52

ssh_scan

DEPRECATED - A prototype SSH configuration and policy scanner (Blog: https://mozilla.github.io/ssh_scan/)
Ruby
793
star
53

chromeless

DEPRECATED - Build desktop applications with web technologies.
JavaScript
761
star
54

node-client-sessions

secure sessions stored in cookies
JavaScript
745
star
55

blurts-server

Mozilla Monitor arms you with tools to keep your personal information safe. Find out what hackers already know about you and learn how to stay a step ahead of them.
Fluent
727
star
56

playdoh

PROJECT DEPRECATED (WAS: "Mozilla's Web application base template. Half Django, half awesomeness, half not good at math.")
Python
714
star
57

DeepSpeech-examples

Examples of how to use or integrate DeepSpeech
Python
682
star
58

cargo-vet

supply-chain security for Rust
Rust
665
star
59

tofino

Project Tofino is a browser interaction experiment.
HTML
655
star
60

addon-sdk

DEPRECATED - The Add-on SDK repository.
641
star
61

standards-positions

Python
639
star
62

MozStumbler

Android Stumbler for Mozilla
Java
621
star
63

application-services

Firefox Application Services
Rust
608
star
64

fxa

Monorepo for Mozilla Accounts (formerly Firefox Accounts)
TypeScript
593
star
65

lightbeam

Orignal unmaintained version of the Lightbeam extension. See lightbeam-we for the new one which works in modern versions of Firefox.
JavaScript
587
star
66

firefox-translations

Firefox Translations is a webextension that enables client side translations for web browsers.
JavaScript
579
star
67

moz-sql-parser

DEPRECATED - Let's make a SQL parser so we can provide a familiar interface to non-sql datastores!
Python
574
star
68

spidernode

Node.js on top of SpiderMonkey
JavaScript
560
star
69

ichnaea

Mozilla Ichnaea
Python
559
star
70

inclusion

Our repository for Diversity, Equity and Inclusion work at Mozilla
557
star
71

positron

a experimental, Electron-compatible runtime on top of Gecko
551
star
72

addons-frontend

Front-end to complement mozilla/addons-server
JavaScript
525
star
73

nixpkgs-mozilla

Mozilla overlay for Nixpkgs.
Nix
522
star
74

tls-observatory

An observatory for TLS configurations, X509 certificates, and more.
Go
518
star
75

bugbug

Platform for Machine Learning projects on Software Engineering
Python
503
star
76

neo

INACTIVE - http://mzl.la/ghe-archive - DEPRECATED: See https://neutrino.js.org for alternative
JavaScript
503
star
77

notes

DEPRECATED - A notepad for Firefox
HTML
495
star
78

django-csp

Content Security Policy for Django.
Python
486
star
79

skywriter

Mozilla Skywriter
JavaScript
481
star
80

Spoke

Easily create custom 3D environments
JavaScript
480
star
81

zamboni

Backend for the Firefox Marketplace
Python
474
star
82

vtt.js

A JavaScript implementation of the WebVTT specification
JavaScript
461
star
83

FirefoxColor

Theming demo for Firefox Quantum and beyond
JavaScript
460
star
84

mozilla-django-oidc

A django OpenID Connect library
Python
448
star
85

libdweb

Extension containing an experimental libdweb APIs
JavaScript
441
star
86

pointer.js

INACTIVE - http://mzl.la/ghe-archive - INACTIVE - http://mzl.la/ghe-archive - Normalizes mouse/touch events into 'pointer' events.
JavaScript
435
star
87

agithub

Agnostic Github client API -- An EDSL for connecting to REST servers
Python
419
star
88

cubeb

Cross platform audio library
C++
411
star
89

fxa-auth-server

DEPRECATED - Migrated to https://github.com/mozilla/fxa
JavaScript
401
star
90

zilla-slab

Mozilla's Zilla Slab Type Family
Shell
398
star
91

r2d2b2g

Firefox OS Simulator is a test environment for Firefox OS. Use it to test your apps in a Firefox OS-like environment that looks and feels like a mobile phone.
JavaScript
391
star
92

masche

Deprecated - MIG Memory Forensic library
Go
387
star
93

qbrt

CLI to a Gecko desktop app runtime
JavaScript
386
star
94

mp4parse-rust

Parser for ISO Base Media Format aka video/mp4 written in Rust.
Rust
380
star
95

valence

INACTIVE - http://mzl.la/ghe-archive - Firefox Developer Tools protocol adapters (Unmaintained)
JavaScript
377
star
96

OpenDesign

Mozilla Open Design aims to bring open source principles to Creative Design. Find us on Matrix: chat.mozilla.org/#/room/#opendesign:mozilla.org
370
star
97

ssl-config-generator

Mozilla SSL Configuration Generator
Handlebars
366
star
98

reflex

Functional reactive UI library
JavaScript
364
star
99

mortar

INACTIVE - http://mzl.la/ghe-archive - A collection of web app templates
364
star
100

minion

Minion
354
star