Skip to content

Selor/badgr-server

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Badgr Server

Digital badge management for issuers, earners, and consumers

Badgr Server provides an API for issuing Open Badges. It will soon provide integrated badge management and sharing for badge earners and tools for inspection, exploration and discovery of Open Badges and a world of learning opportunities.

Version: Developer Preview 0.1.1

How to get started on your local development environment.

Prerequisites:

  • python 2.7.x
  • virtualenv
  • npm
  • gulp

Create project directory and environment

  • mkdir badgr-home
  • virtualenv env
  • source env/bin/activate Activate the environment (each time you start a session working with the code)

Obtain source code

  • git clone git@github.com:concentricsky/badgr-home.git code
  • cd code

Install requirements

from within code directory

  • pip install -r requirements.txt
  • npm install

Customize local settings to your environment

  • cp apps/mainsite/settings_local.py.example apps/mainsite/settings_local.py
  • Edit the settings_local.py file and insert local credentials for DATABASES and email, then run the following from within the code directory:

Migrate databases, build front-end components

  • ./manage.py migrate
  • gulp build
  • ./manage py createsuperuser

Run a server

A browseable API is available at /v1 and documentation at /docs

If you choose to use the BADGR_APPROVED_ISSUERS_ONLY flag, this means new user accounts will not be able to define new issuers (though they can be added as staff on issuers defined by others) unless they have the Django user permission 'issuer.add_issuer'. The recommended way to grant users this privilege is to create a group that grants it in the /staff admin area and addthe appropriate users to that group.

About

Open Badge issuing and management with Django

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 39.7%
  • CSS 27.5%
  • JavaScript 26.0%
  • HTML 6.8%