Mohamed Youssef
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# Product Phase Out Module for OpenCart 3
|
|
|
|
An OpenCart 3.x module that automatically disables products when they go out of stock and re-enables them when stock is replenished.
|
|
|
|
## Features
|
|
|
|
### 🚀 Automatic Product Status Management
|
|
- Automatically disables products when quantity reaches zero after an order
|
|
- Re-enables products when stock is replenished (e.g., through order cancellation or manual adjustment)
|
|
- No core file changes required - uses OCMOD system
|
|
|
|
### 📦 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. The `install.xml` is pre-configured for the Product Phase Out functionality
|
|
3. Place any additional module files in the `upload/` directory if needed
|
|
4. Add installation scripts if needed (`install.php`, `install.sql`)
|
|
5. Push to your repository to trigger automatic release build
|
|
|
|
## Usage
|
|
|
|
### For Store Owners
|
|
1. Download the generated `.ocmod.zip` from releases
|
|
2. Upload via OpenCart's Extension Installer
|
|
3. The module will automatically manage product status based on stock levels
|
|
|
|
### For Developers
|
|
1. Modify `install.xml` to customize the behavior
|
|
2. Add custom files to `upload/` directory
|
|
3. Test locally before deploying
|
|
|
|
## Changelog
|
|
|
|
### v1.0.0
|
|
- Initial release
|
|
- Automatic product disabling when out of stock
|
|
- Automatic product re-enabling when stock is replenished
|
|
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.
|