Initial commit: Add README for Andal Open edX Plugins
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
85
README.md
Normal file
85
README.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Open edX Plugins by Andal
|
||||
|
||||
A public repository of custom Open edX plugins developed by [Andal](https://andal.dev). These plugins extend and enhance the Open edX learning management system.
|
||||
|
||||
## Plugins
|
||||
|
||||
This repository contains the following plugins:
|
||||
|
||||
| Plugin | Description |
|
||||
|--------|-------------|
|
||||
| — | — |
|
||||
|
||||
*(Plugins will be listed here as they are added)*
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Open edX](https://openedx.org/) (Lilys or later)
|
||||
- Python 3.8+
|
||||
- Open edX Tutor (recommended for installation)
|
||||
|
||||
## Installation
|
||||
|
||||
Each plugin can be installed individually. Refer to the individual plugin's README for specific installation instructions.
|
||||
|
||||
### Generic Installation
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/andal/plugins.git
|
||||
cd plugins
|
||||
|
||||
# Install a specific plugin
|
||||
pip install ./<plugin-name>
|
||||
```
|
||||
|
||||
### Using Tutor
|
||||
|
||||
Add the plugin to your Open edX custom plugins configuration:
|
||||
|
||||
```yaml
|
||||
OPENEDX_PLUGIN_SETTINGS:
|
||||
<plugin-name>:
|
||||
KEY: value
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/andal/plugins.git
|
||||
cd plugins
|
||||
|
||||
# Create a virtual environment
|
||||
python -m venv venv
|
||||
source venv/bin/activate # Linux/Mac
|
||||
# or
|
||||
venv\Scripts\activate # Windows
|
||||
|
||||
# Install development dependencies
|
||||
pip install -e .[dev]
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
1. Fork the repository
|
||||
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
||||
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
||||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0) - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Contact
|
||||
|
||||
- **Website**: [andal.dev](https://andal.dev)
|
||||
- **Email**: contact@andal.dev
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- [Open edX](https://openedx.org/) community
|
||||
- [OpenCraft](https://opencraft.com/) and the entire Open edX ecosystem
|
||||
Reference in New Issue
Block a user