Skip to content

giancosta86/OmniCourse-core

Repository files navigation

OmniCourse-core

Core model for OmniCourse

GitHub CI npm version MIT License

Introduction

OmniCourse-core is a TypeScript library providing the core model of the OmniCourse project; as a consequence, it is especially useful whenever you need to access its data structures without having to depend on the UI components.

Installation

First of all, please consider whether you actually need the full OmniCourse library: in that case, directly depending on OmniCourse-core is not required - as the data structures are exported by OmniCourse as well.

OmniCourse-core can be installed like any NPM package:

yarn add @giancosta86/omnicourse-core

The public API entirely resides in the root package index, so you shouldn't reference specific modules.

For details about installing and using the whole OmniCourse project, please refer to the tutorial wiki page.

Using the library

OmniCourse is described in detail in its wiki: for this library, please refer to the core model section.

See also