This repository contains the core backend logic for the AAC Moodle Chatbot. All backend processing and integrations must be managed here.
⚠️ Note: Do not mix frontend or UI activity code with this repository. All UI code should reside in the moodle-chatbot repository.
Follow these steps to install the plugin into your Moodle environment:
-
Download the latest ZIP archive of this repository.
-
Navigate to Moodle and proceed to:
Site Administration → Plugins → Install Plugins → Install plugin from ZIP file -
Upload the downloaded ZIP file and complete the installation.
The plugin will be installed at:
local/geniai
Ensure synchronization between backend updates and frontend UI changes:
- After updating backend logic, ensure any relevant API changes or adjustments are reflected in the frontend chatbot activity plugin.
- Reminder: Do not push frontend UI/activity code to this backend repository.
To contribute to this project, follow the structured Git workflow:
Clone via SSH:
git clone [email protected]:DrKat0m/Geniai_Base_Plugin.git
cd Geniai_Base_PluginCreate and switch to your branch:
git checkout -b your-feature-branchMake your changes, then stage, commit, and push:
git add .
git commit -m "Descriptive commit message"
git push -u origin your-feature-branchOpen a Pull Request on GitHub for review and merging.
For setting up Xdebug with PHP, refer to Kartavya’s comprehensive guide on Discord:
Follow these instructions for a clean setup:
-
Ensure Git installation: Download Git
-
Navigate to Moodle's local plugins directory:
cd D:\xampp\htdocs\moodle\local- Clone the repository:
git clone [email protected]:DrKat0m/Geniai_Base_Plugin.git- Create a working branch:
cd Geniai_Base_Plugin
git checkout -b your-feature-branch- Commit only backend changes to this repository.
- Update dependent frontend changes in the moodle-chatbot repository promptly.
- Do not push chatbot activity module or block code to this repository to prevent codebase clutter and conflicts.