Initial commit

2026-04-10 19:09:13 +02:00
commit 0cb8ca0f46
3 changed files with 152 additions and 0 deletions
@@ -0,0 +1,68 @@
+# OpenCart 3 Module Template
+
+A comprehensive template for developing custom modules and extensions for OpenCart 3.x e-commerce platform.
+
+## Features
+
+### 🚀 OpenCart 3 Compatibility
+- Fully compatible with OpenCart 3.x versions
+- Uses OCMOD (OpenCart Modification) system for safe modifications
+- No core file changes required
+
+### 📦 Module Structure
+- **install.xml**: OCMOD installation file with modification definitions
+- **upload/**: Directory for module files to be uploaded to OpenCart
+- **install.php**: Optional PHP installation script
+- **install.sql**: Optional database installation script
+
+### 🔄 Automated Releases
+- Integrated Gitea Actions workflow for automatic builds
+- Generates `.ocmod.zip` packages on push to main branch
+- Extracts metadata from `install.xml` for versioning
+- Ready-to-install extension packages
+
+### 🛠️ Development Tools
+- XML-based modification system
+- Template structure for rapid module development
+- CI/CD pipeline for quality assurance
+- Version management through install.xml
+
+## Installation
+
+1. Clone this repository
+2. Customize the `install.xml` with your module details:
+   - Set `<name>`, `<code>`, and `<version>`
+   - Add your modifications in the `<file>` sections
+3. Place your module files in the `upload/` directory
+4. Add installation scripts if needed (`install.php`, `install.sql`)
+5. Push to your repository to trigger automatic release build
+
+## Usage
+
+### For Module Developers
+1. Use this template as a starting point for new OpenCart modules
+2. Define your modifications in `install.xml`
+3. Add custom files to `upload/` directory
+4. Test locally before deploying
+
+### For Store Owners
+1. Download the generated `.ocmod.zip` from releases
+2. Upload via OpenCart's Extension Installer
+3. Install and configure the module through admin panel
+
+## Requirements
+
+- OpenCart 3.x
+- PHP 7.3 or higher
+- MySQL 5.7 or higher
+- OCMOD support enabled
+
+## Author
+
+**Mohamed Youssef**  
+Website: [my-dev.pro](https://my-dev.pro)  
+Email: Contact through website
+
+## License
+
+This template is provided as-is for OpenCart module development. Please check individual module licenses for usage terms.