Meta repository for MoIRA (MoKITUL Integrated Retrieval Agent) for Moodle
In case you just want to know how to setup up MoIRA, refer to the example setup.
- 🧪 Research Project – Moodle Plugin Suite & Python API
- 🚀 Goals & Background
⚠️ Disclaimer- 🫶 Contributions Welcome!
- 📺 Demonstration
- ⚙️ How to setup
- 🧑💻 Development
- 📜 Roadmap
- 📄 License
- 💌 Contact
This repository bundles a collection of Moodle plugins and an accompanying Python API, developed as part of a research project. The software is (currently) not intended for production use, but rather as an experimental foundation and contribution to the community.
We are releasing the source code as open source, in the hope that it may help others – whether as inspiration, foundation, or for further development.
It is currently being tested internally at the University of Applied Sciences Erfurt and used in selected degree programmes in collaboration with other lecturers.
This plugin suite was created as part of a research project at the University of Applied Sciences Erfurt. Our goals were multifaceted: we aimed to explore interactive teaching formats, enable local data processing through self-hosted components, support learning analytics, and reduce the need for constant platform switching in students' d C401 igital learning environments.
Originally designed for internal use, we are now making the code publicly available to foster further development within the community and inspire others.
We originally launched the project as MoKITUL. Problems arised as both the research project and this byproduct were hard to differentiate. To get around this we renamed the application to MoIRA. Beware that some of the plugins might still be called Mokitul_Block_Plugin or similar. This will be changed in the future.
This project is a by-product of our research and is not intended for productive Moodle installations. The code may contain bugs and has not undergone complete security audits. Usage is at your own risk.
We welcome feedback, suggestions, or pull requests! If you are interested in contributing to the project, feel free to get in touch via the issue tracker or by email.
A detailed guide on how to setup can be founde here: example setup. This repository also contains a configuration suitable for develpoment and test purposes.
To develop locally, the following services and tools are required:
- Full Moodle setup (version 4 or higher) including database
- MongoDb
- Python 3.11+
- Task
- Node.js
- Git
- Git LFS
Alternatively, Docker can be used to run the services and databases locally. Dev containers may be used for Python, Node.js and Task support.
An example Moodle development environment will be provided soon.
If you wish to use docker you can refer to the example setup provided in the How to setup section fo this readme.
| Component | Type | Repository Link |
|---|---|---|
| mokitul_block_plugin | Block | GitHub |
| mokitul_activity_plugin | Activity | GitHub |
| mokitul_core_plugin | Core/Lib | GitHub |
| mokitul_api | API | GitHub |
| moodle_client | Frontend | GitHub |
- mokitul_block_plugin_moodle: A classic block plugin that can be embedded on Moodle dashboards or course pages. Primarily serves as an entry point to interact with other components.
- mokitul_activity_plugin_moodle: A custom activity that is embedded directly in courses. It provides an interface for students to complete tasks and collects data for analysis.
- mokitul_core_plugin: A local plugin providing helper functions, API access, and reusable logic. Shared by the block and activity plugins.
- mokitul_api: A standalone Python-based REST API serving as a bridge between Moodle and data processing (e.g. indexing, llm).
- moodle_client: A React application injected via the core plugin.
graph TD
subgraph Moodle Platform
UI[Moodle UI]
Block[mokitul_block_plugin]
Activity[mokitul_activity_plugin]
Core[mokitul_core_plugin]
React[moodle_client]
end
subgraph External
API[mokitul_api]
DB[(MongoDB)]
end
%% User interaction
UI --> Block
UI --> Activity
%% Plugins and communication
Block --> Core
Activity --> Core
React --> Core
%% Core plugin communicates with API
Core --> API
API --> DB
Once all tools are installed, individual components can be cloned:
git clone https://github.com/MoKITUL-FH-Erfurt/mokitul_block_plugin_moodle
cd mokitul_block_plugin_moodletaskEach plugin will be bundled into a ZIP file that can be uploaded to Moodle. Both the activity and block plugins require the core plugin.
The Moodle client is a React application integrated into Moodle via the activity and block plugins. It is provided through the core plugin. During development, the app can be deployed directly into a Docker container using the Taskfile to simplify local testing and iteration.
taskFurther documentation coming soon.
The user interface has been slightly revised. These updates are not yet included in the repository but will be added as soon as possible. There are also various ideas and feature requests, which will be tracked as issues and tasks once confirmed.
This project is licensed under the MIT License.
Dependencies using different licenses are documented in the respective repositories in the Notice.md file.
This project is not affiliated with Moodle or MongoDB. Moodle and MongoDB are registered trademarks. Our project merely develops and provides plugins for use within Moodle.