educandu-plugin-charts

A charts plugin for educandu

Prerequisites

• node.js ^20.0.0
• optional: globally installed gulp: npm i -g gulp-cli

The output of this repository is an npm package (@musikisum/educandu-plugin-charts).

Usage

Import the published package into your educandu driven website:

$ yarn add @musikisum/educandu-plugin-charts

Add the plugin info to the application's custom resolvers module:

import ChartsPlugin from '@musikisum/educandu-plugin-charts';

export default {
  resolveCustomPageTemplate: null,
  resolveCustomHomePageTemplate: null,
  resolveCustomSiteLogo: null,
  resolveCustomPluginInfos: () => [ChartsPlugin]
};

Add the plugin name, the translations and any additional controllers to your server config:

import educandu from '@educandu/educandu';
import { createRequire } from 'node:module';
import ChartsController from '@musikisum/educandu-plugin-charts/charts-controller.js';

const require = createRequire(import.meta.url);
const chartsPluginTranslationsPath = require.resolve('@musikisum/educandu-plugin-charts/translations.json');

educandu({
  plugins: [/* your other plugins here */, 'musikisum/educandu-plugin-charts'],
  resources: [/* your other translations here */, chartsPluginTranslationsPath],
  additionalControllers: [/* your other additional controllers here */, ChartsController],
  /* your other server config here */
});

Import the plugin styles to your main LESS entry point:

// Base styles from Educandu:
@import url('@educandu/educandu/styles/main.less');

// Styles for the custom plugin:
@import url('@musikisum/educandu-plugin-charts/charts.less');

// Other styles here

OER learning platform for music

Funded by 'Stiftung Innovation in der Hochschullehre'

A Project of the 'Hochschule für Musik und Theater München' (University for Music and Performing Arts)

Project owner: Hochschule für Musik und Theater München
Project management: Ulrich Kaiser