Conversion of Custom WordPress Shipping Zone Plugin to Installable Package -- 2
Budget: $200 – $1,000 USD
Project Overview: You have a custom WordPress and WooCommerce plugin that integrates Google Maps API for creating new shipping zones. These zones can be drawn directly onto a Google Map within the WordPress admin area. The plugin also allows setting different shipping prices, minimum, and maximum quantities for product classes within those zones. The goal is to package this existing plugin into a distributable .zip file that can be installed on any WordPress site with WooCommerce.
Project Goals:
1. Package the existing WordPress/WooCommerce plugin into a portable .zip file.
2. Ensure the plugin works correctly upon activation on a new WordPress site.
3. Enable users to input their Google API Key through a settings page within WordPress.
4. Ensure users can create new zones, and adjust pricing and quantity settings post-installation.
Scope of Work:
1. Assessment and Code Audit:
o Review current plugin codebase.
o Identify any hard-coded settings or site-specific configurations.
o Ensure compliance with WordPress coding standards.
2. Environment Configuration:
o Define WordPress version compatibility.
o Enumerate WooCommerce version requirements.
o List any other plugin dependencies.
3. Plugin Packaging:
o Reorganize the file structure for standard WordPress plugin architecture.
o Create a clean uninstallation process to remove all settings and
data.
o Generate a .zip file for the plugin.
4. Settings Page Development:
o Create an admin settings page for the plugin.
o Implement a field for entering and storing the Google API Key.
o Ensure the admin can configure shipping zone details (prices,
min/max quantities).
5. Google Maps Integration:
o Validate the integration with Google Maps API after the user
adds their API key.
o Implement the map interface for drawing shipping zones if not
already in place.
o Develop the functionality to save, edit, and delete drawn zones
within WordPress.
6. Shipping Logic Implementation:
o Ensure the plugin can accurately determine if a user's address
is within a zone during checkout.
o Validate that product quantities meet the defined thresholds for
the zone.
o Appropriately adjust shipping costs based on the zone and
product class.
7. Compatibility Testing:
o Test across various WordPress and WooCommerce versions.
o Ensure the plugin is compliant with the latest versions.
o Test for potential conflicts with other common plugins.
8. Documentation:
o Write detailed installation instructions.
o Provide user guidance for configuring and using the plugin.
o Document troubleshooting steps for common issues.
9. Deployment and Installation:
o Procedure for installing the plugin via .zip file.
o Instructions on activating and deactivating the plugin.
o Guidelines on updating the plugin when new versions are
released.
Deliverables:
1. A zipped WordPress plugin ready for installation.
2. A settings page for the plugin's configuration within the
WordPress admin area.
3. Comprehensive user documentation and installation guide.
• Previous experience with WordPress plugin development—
particularly involving WooCommerce.
• Knowledge of Google Maps API integration in WordPress.
• Strong understanding of PHP, JavaScript (especially concerning
AJAX requests), and WordPress hooks and filters.
• Proof of ability to troubleshoot and debug issues across
different WordPress environments.
• Excellent communication skills and adherence to deadlines.
Project Goals:
1. Package the existing WordPress/WooCommerce plugin into a portable .zip file.
2. Ensure the plugin works correctly upon activation on a new WordPress site.
3. Enable users to input their Google API Key through a settings page within WordPress.
4. Ensure users can create new zones, and adjust pricing and quantity settings post-installation.
Scope of Work:
1. Assessment and Code Audit:
o Review current plugin codebase.
o Identify any hard-coded settings or site-specific configurations.
o Ensure compliance with WordPress coding standards.
2. Environment Configuration:
o Define WordPress version compatibility.
o Enumerate WooCommerce version requirements.
o List any other plugin dependencies.
3. Plugin Packaging:
o Reorganize the file structure for standard WordPress plugin architecture.
o Create a clean uninstallation process to remove all settings and
data.
o Generate a .zip file for the plugin.
4. Settings Page Development:
o Create an admin settings page for the plugin.
o Implement a field for entering and storing the Google API Key.
o Ensure the admin can configure shipping zone details (prices,
min/max quantities).
5. Google Maps Integration:
o Validate the integration with Google Maps API after the user
adds their API key.
o Implement the map interface for drawing shipping zones if not
already in place.
o Develop the functionality to save, edit, and delete drawn zones
within WordPress.
6. Shipping Logic Implementation:
o Ensure the plugin can accurately determine if a user's address
is within a zone during checkout.
o Validate that product quantities meet the defined thresholds for
the zone.
o Appropriately adjust shipping costs based on the zone and
product class.
7. Compatibility Testing:
o Test across various WordPress and WooCommerce versions.
o Ensure the plugin is compliant with the latest versions.
o Test for potential conflicts with other common plugins.
8. Documentation:
o Write detailed installation instructions.
o Provide user guidance for configuring and using the plugin.
o Document troubleshooting steps for common issues.
9. Deployment and Installation:
o Procedure for installing the plugin via .zip file.
o Instructions on activating and deactivating the plugin.
o Guidelines on updating the plugin when new versions are
released.
Deliverables:
1. A zipped WordPress plugin ready for installation.
2. A settings page for the plugin's configuration within the
WordPress admin area.
3. Comprehensive user documentation and installation guide.
• Previous experience with WordPress plugin development—
particularly involving WooCommerce.
• Knowledge of Google Maps API integration in WordPress.
• Strong understanding of PHP, JavaScript (especially concerning
AJAX requests), and WordPress hooks and filters.
• Proof of ability to troubleshoot and debug issues across
different WordPress environments.
• Excellent communication skills and adherence to deadlines.