Skip to content
This repository has been archived by the owner on Sep 12, 2021. It is now read-only.
/ BlackboardAPI Public archive

An API to communicate with a Blackboard server.

License

Notifications You must be signed in to change notification settings

wbrinksma/BlackboardAPI

Repository files navigation

This repository is not actively maintained anymore and is therefore archived.

package version status
blackboardlib LatestVersion Build Status
blackboardlib-cli LatestVersion Build Status

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.

In the meantime you should be able to use the current product, however be aware of possible bugs.

Getting started

Documentation

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

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