kapstok / BlackboardAPI

An API to communicate with a Blackboard server.

package	version	status
blackboardlib
blackboardlib-cli

BlackboardAPI

An API to communicate with a Blackboard server. This can be used to build apps on the Blackboard platform that can either be hosten on-site or off-site through the use of special loaders.

This project is still in its infancy, meaning that it will not work fully until a stable release is published.

Currently, the build process relies on webpack which in turn uses npm and the Typescript compiler with separate configuration files. This might change in the future.

Getting started

Documentation

To get started, these markdown files are probably of use:

• The structure of the code

• How to create an assignment column using the API

• How to send emails to course members using the API

• Using the Blackboard CLI

Building

$ npm i # First run only
$ npm run build

Usage

This library is available as NPM package. Please refer to the examples to see how to use the library.

Learn by example

React-Example is a useful example on how to use the BlackboardAPI with a minimal webpack in react.

Webpack-Example is a useful example on how to use the BlackboardAPI with a minimal webpack configuration.

TSLint

$ npm run lint