docs: add comprehensive README with OpenRouter config
This commit is contained in:
@@ -1,17 +1,34 @@
|
||||
<p align="center"><a
|
||||
href="https://www.flaticon.com/free-icons/mortarboard" target="_blank" rel="noopener noreferrer"
|
||||
title="Mortarboard icons created by itim2101 - Flaticon" ><img src="./extension/icon.png" alt="Mortarboard icons created by itim2101 - Flaticon" width="150" style="display:block; margin:auto;"></a></p>
|
||||
# MoodleGPT (SparkAssist)
|
||||
|
||||
<<<<<<< HEAD
|
||||
MoodleGPT is a powerful AI-powered study assistant designed as a Chrome extension. It seamlessly integrates with your learning management system to provide intelligent assistance for your quizzes and study materials.
|
||||
=======
|
||||
# SparkAssist 2.0.0
|
||||
>>>>>>> bf57b73971a42a1c0e143bb86ee9d695a80ac12c
|
||||
|
||||
This extension allows you to hide CHAT-GPT in a Moodle quiz. You just need to click on the question you want to solve, and CHAT-GPT will automatically provide the answer. However, one needs to be careful because as we know, CHAT-GPT can make errors especially in calculations.
|
||||
## Features
|
||||
|
||||
## Chrome Webstore
|
||||
- **AI-Powered Assistance:** Get help with quizzes and study material directly within your browser.
|
||||
- **Customizable Models:** Bring your own API key (BYOK) and use the AI models of your choice.
|
||||
- **Modern Interface:** A clean, fast, and responsive popup interface built with Preact and Tailwind CSS.
|
||||
|
||||
Find the extension on the Chrome Webstore right [here](https://chrome.google.com/webstore/detail/moodlegpt/fgiepdkoifhpcgdhbiikpgdapjdoemko)
|
||||
## Functionality Overview
|
||||
|
||||
## Summary
|
||||
MoodleGPT is built to understand the structure of Moodle quizzes and provide context-aware solutions. Key capabilities include:
|
||||
|
||||
<<<<<<< HEAD
|
||||
- **Comprehensive Question Support:** It automatically parses a wide variety of Moodle question types, including:
|
||||
- Multiple Choice (Radio Buttons & Checkboxes)
|
||||
- Select / Dropdowns
|
||||
- Drag and Drop (Gap Select, DDWTOS)
|
||||
- Matching and Ordering
|
||||
- Numerical and Text Inputs
|
||||
- Atto and ContentEditable Rich Text areas
|
||||
- **Operating Modes:**
|
||||
- **Autocomplete Mode:** Automatically applies the AI-generated answers directly into the Moodle interface where possible.
|
||||
- **Clipboard Mode:** Copies the generated answers to your clipboard for manual input.
|
||||
- **Context-Aware AI Parsing:** It reads the full history and context of the quiz page to provide highly accurate, tailored responses based on the prompt structure.
|
||||
=======
|
||||
- [SparkAssist 2.0.0](#sparkassist-200)
|
||||
- [Chrome Webstore](#chrome-webstore)
|
||||
- [Summary](#summary)
|
||||
@@ -38,31 +55,61 @@ Find the extension on the Chrome Webstore right [here](https://chrome.google.com
|
||||
- [What about if the question can't be autocompleted ?](#what-about-if-the-question-cant-be-autocompleted-)
|
||||
- [Test](#test)
|
||||
- [Beta version with advanced features](#beta-version-with-advanced-features)
|
||||
>>>>>>> bf57b73971a42a1c0e143bb86ee9d695a80ac12c
|
||||
|
||||
## Disclaimer !
|
||||
## Installation
|
||||
|
||||
I hereby declare that I am not responsible for any misuse or illegal activities carried out using my program. The code is provided for educational and research purposes only, and any use of it outside of these purposes is at the user's own risk.
|
||||
1. Clone this repository to your local machine:
|
||||
```bash
|
||||
git clone https://git.lucida.ee/blackicedbear/MoodleGPT
|
||||
```
|
||||
2. Navigate to the project directory:
|
||||
```bash
|
||||
cd MoodleGPT
|
||||
```
|
||||
3. Install the required dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
4. Build the extension:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
5. Open Chrome and navigate to `chrome://extensions/`.
|
||||
6. Enable **Developer mode** in the top right corner.
|
||||
7. Click **Load unpacked** and select the `extension` directory from the cloned repository.
|
||||
|
||||
## Donate
|
||||
## Configuration & Model Setup
|
||||
|
||||
Will be a pleasure if you want to support this project :). I'm alone working on this project and I'm still a student.
|
||||
<br/>
|
||||
<a href="https://www.buymeacoffee.com/yoannchbpro" target="_blank" rel="noopener noreferrer"><img src="./assets/bmc-button.png" alt="Mortarboard icons created by itim2101 - Flaticon" width="150"></a>
|
||||
MoodleGPT allows you to configure your preferred AI model. We highly recommend using **OpenRouter** as it gives you access to a wide variety of models and supports a "Bring Your Own Key" (BYOK) approach.
|
||||
|
||||
## Update
|
||||
### Setting up OpenRouter
|
||||
|
||||
See the [changelog](./CHANGELOG.md) to see every updates !
|
||||
1. **Get an API Key:** Sign up at [OpenRouter.ai](https://openrouter.ai/) and generate your API key.
|
||||
2. **Open the Extension Settings:** Click on the MoodleGPT extension icon in your browser toolbar to open the popup. Navigate to the settings or configuration area.
|
||||
3. **Configure the API:**
|
||||
- **API Key:** Enter your OpenRouter API key.
|
||||
- **Base URL:** Due to browser extension CORS restrictions with OpenRouter, you should use our dedicated CORS proxy. Enter the following URL into the Base URL field:
|
||||
```text
|
||||
https://openrouter-proxy-209510473297.us-central1.run.app
|
||||
```
|
||||
- **Model:** Specify the OpenRouter model you wish to use (e.g., `google/gemini-3.1-pro-preview`, `anthropic/claude-opus-4.7`, `openai/gpt-5.5`, etc.).
|
||||
|
||||
## Set up
|
||||
Once configured, the extension will route your requests securely through the proxy to OpenRouter, allowing you to seamlessly use any of their available models.
|
||||
|
||||
> NOTE: This extension only works on Chromium-based browsers like Edge, Chrome, etc.
|
||||
## Development
|
||||
|
||||
<p align="center">
|
||||
<img src="./assets/setup.png" alt="Popup" width="300">
|
||||
</p>
|
||||
- `npm run build` - Full build (lints, formats, builds CSS, and bundles JS)
|
||||
- `npm run build:css` - Compiles the Tailwind CSS
|
||||
- `npm run fastBuild` - Bundles the JavaScript using Rollup
|
||||
- `npm run lint` - Lints the codebase
|
||||
- `npm run prettier` - Formats the codebase
|
||||
|
||||
Go to <b>"Manage my extensions"</b> on your browser, then click on <b>"Load unpacked extension"</b> and select the <b>"extension"</b> folder. Afterwards, click on the extension icon and enter the ApiKey obtained from [openai api](https://platform.openai.com/api-keys). Finally, select a [gpt model](https://platform.openai.com/docs/models) (ensure it work with completion api).
|
||||
## License
|
||||
|
||||
<<<<<<< HEAD
|
||||
This project is licensed under the MIT License.
|
||||
=======
|
||||
## Settings
|
||||
|
||||
- <b>API KEY\*</b>: Your openai [API KEY](https://platform.openai.com/api-keys)
|
||||
@@ -191,3 +238,4 @@ To know if the answer has been copied to the clipboard, you can look at the titl
|
||||
## Beta version with advanced features
|
||||
|
||||
If you're interested in accessing advanced features ahead of their official release, please consider downloading the extension from the [dev branch](https://github.com/yoannchb-pro/MoodleGPT/tree/dev). However, please be aware that this branch is under development and may contain bugs. If you encounter any issues, don't hesitate to contact me or create an issue on GitHub. Your feedback is invaluable in helping us improve the extension.
|
||||
>>>>>>> bf57b73971a42a1c0e143bb86ee9d695a80ac12c
|
||||
|
||||
Reference in New Issue
Block a user