search

mebis-lp / moodle-mod_mootimeter

Other
9 stars 7 forks source link

readme

Mootimeter

Mootimeter is a stand-alone activity plugin for moodle that enables live polls.

Mootimeter currently has the following polling tools:

Thanks to its submodule structure, Mootimeter can easily be extended with additional polling tools. An extensive API is available for the creation of further polling tools.

Installing via uploaded ZIP file

  1. Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
  2. Upload the ZIP file with the plugin code. You should only be prompted to add extra details if your plugin type is not automatically detected.
  3. Check the plugin validation report and finish the installation.

Installing manually

The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/mod/mootimeter

Afterwards, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php

to complete the installation from the command line.

Changes to styles.scss and files in scss/*

If you want to change styles, you need to compile the scss files into css after you made your changes, so they will be picked up. For doing so, just run npm install once after cloning the repository.

Whenever you have applied changes to styles.scss or any file in scss/ directory, you need to run npm run compile-sass in the plugin root directory. This creates the styles.css file which is being read and used by moodle.

Compiling SCSS with VS Code

For SCSS compilation in this Moodle plugin, the use of VS Code and the extension Live Sass Compiler is recommended.

The extension can recognize SCSS files and compile them as required. Certain settings can be made for this. These are described in more detail on the plugin page. The following is a standard configuration which is compatible with Mootimeter:

"liveSassCompile.settings.includeItems": [
        "/**/mootimeter/styles.s[ac]ss",
],
"liveSassCompile.settings.generateMap": false,
"liveSassCompile.settings.partialsList": [
    "/**/mootimeter/scss/**/*.s[ac]ss",
],

License

2023, ISB Bayern

Lead developer: Dr. Peter Mayer peter.mayer@isb.bayern.de

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.