Skip to content
No description, website, or topics provided.
Branch: develop
Clone or download
Ethan Sletteland
Latest commit ae8126e Jun 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add Issue Template redirecting users mostly to badgr-server issues Mar 20, 2018
e2e GTS Code Style: Fixed all tslint-related issues Feb 22, 2019
src BGR-3815: Remove debugging and linting fix. Jun 5, 2019
.clang-format Added missing .clang-format for gts Mar 5, 2019
.editorconfig BGR-2813: WIP - Removed some old webpack config files; initial work o… Dec 5, 2018
.gitignore BGR-2813: Removed unnecessary ignored files in .gitignore Dec 19, 2018
.nvmrc initial opensource commit Dec 18, 2017
.travis.yml Use tabs Jun 3, 2019
CHANGELOG.md v2.19.3 CHANGELOG Nov 14, 2018
LICENSE Add aGPL license and project description to README Dec 19, 2017
README.md Improve README to resolve #49 Mar 12, 2019
SPECFILE initial opensource commit Dec 18, 2017
angular.json Disabled circular dependency warnings because they aren't problematic Feb 18, 2019
badgr-ui-code-style.xml initial opensource commit Dec 18, 2017
html-minifier.config.json BGR-2967: Added support for remote configuration, updated how theming… Dec 13, 2018
package-lock.json update the pattern library to v15.1.4 May 31, 2019
package.json update the pattern library to v15.1.4 May 31, 2019
run-for-design.sh initial opensource commit Dec 18, 2017
run-prod.sh initial opensource commit Dec 18, 2017
run-server.sh initial opensource commit Dec 18, 2017
tag-branch.js initial opensource commit Dec 18, 2017
tsconfig.json Remove jest from tsconfig types May 17, 2019
tslint.json GTS Code Style: Fixed tslint errors in TypeScript files, switched to … Feb 28, 2019
typedoc.json initial opensource commit Dec 18, 2017
widgets-webpack.config.ts fixes formatting Jan 21, 2019

README.md

Badgr UI

An Angular 2 based front end for Badgr-server. Uses TypeScript with ES6 style module loading and a webpack-based build process. This is the browser UI for badgr-server.

About the Badgr Project

Badgr was developed by Concentric Sky, starting in 2015 to serve as an open source reference implementation of the Open Badges Specification. It provides functionality to issue portable, verifiable Open Badges as well as to allow users to manage badges they have been awarded by any issuer that uses this open data standard. Since 2015, Badgr has grown to be used by hundreds of educational institutions and other people and organizations worldwide.

Install Instructions (for developers)

System-wide prerequisites (OS X):

  • node and npm: see Installing Node
  • (optional) nvm - node version manager: In order to work with multiple projects on your development environment that have diverse dependencies, you may want to have multiple versions of node installed. NVM allows you to do this. If this applies to you, consider using nvm to manage your node environments. nvm use in a project directory with a .nvmrc file will use the recommended node version. Make sure to nvm use [VERSION] the correct version before any npm install steps.

Install and configure project

  • Install and run badgr-server, the API that this application connects to.
  • Install node/npm version using nvm: nvm use && nvm install
  • Install project-specific node dependencies. npm install

Run project in your browser

Start angular in dev mode: npm start. Badgr should now be loaded in your browser. If your browser didn't start automatically, navigate to http://localhost:4200

Ensure it is communicating with the correct API (The port badgr-server is running on)

localStorage.setItem('config', JSON.stringify({api:{baseUrl:"http://localhost:8000"}}))

Run Tests

Run the test suite with npm run test:debug

Run the e2e tests with npm run e2e

Build Instructions (for deployment)

Configuration

To build for production, a environment.prod.ts file must be present in src/environments/. Copy the example file, environment.prod.ts.example to environment.prod.ts and modify it as needed.

Building

Build the packaged files for deployment with npm run build

Run the tests with npm run test

All files in dist constitute the build artifact.

You can’t perform that action at this time.