Project Overview Summary

Project Overview for New Development Team
1. System Overview
Klass Energy operates multiple WordPress websites (11-12) selling home heating oil (kerosene and gas oil). The primary challenge is managing fuel prices, which vary by county in Ireland. To address this, a CodeIgniter dashboard was developed to centralize pricing management and delivery restrictions. Additionally, a custom WordPress plugin was created to replace WooCommerce entirely, ensuring seamless integration with the pricing system.

2. Hosting Details
• WordPress Websites: Hosted on SiteGround.
• CodeIgniter Dashboard: Hosted on our own shared server (server3.thenet.ie)
• Database: Hosted independently on Hetzner, with a mirrored MySQL server for redundancy. The databases are protected with a firewall.
3. Key Technologies & Architecture
• Frontend: WordPress websites with a custom plugin replacing WooCommerce.
• Backend: CodeIgniter dashboard for pricing, delivery dates and order management.
• Database: MySQL hosted on Hetzner (primary and mirrored instances).
• Payments: Integrated with Global Payments, supporting 3D Secure authentication.
• Email Notifications: Sent via Freshdesk for admin alerts and order confirmations.

4. Functionality
4.1 CodeIgniter Dashboard (Admin Panel)
• Manage Pricing: Admins can log in and update prices for fuel volumes (100–1000L).
• Delivery Restrictions: Admins can disable specific areas for delivery on certain dates.
• Order Management: View and update orders (pending → completed).

4.2 WordPress Plugin (Customer Checkout System)
• Location-Based Pricing: Retrieves fuel prices dynamically from the dashboard.
• Checkout & Payment Processing: Handles order submission and payment via Global Payments.
• Order Tracking: Customers receive order confirmation and admins are notified.

5. Staging and Deployment Workflow
• Staging Server: klassenergy.thenet.ie – Used for testing before deployment.
• Version Control: Codebase is maintained in GitHub.
• Deployment Process: Changes are tested on staging → approved → pushed to GitHub → deployed to live sites.

6. Security & Maintenance Considerations
• Firewall Protection: The database is secured with restricted access.
• Regular Updates: CodeIgniter and WordPress plugin updates are tested before deployment.
• Backup Strategy: Redundant MySQL instance at Hetzner ensures data availability.

7. Next Steps for the Development Team
• Familiarize yourself with the CodeIgniter dashboard and its integration with WordPress.
• Review the GitHub repository and understand the deployment process.
• Test changes on the staging server before pushing updates to live sites.
• Ensure compliance with Global Payments security protocols (3D Secure).

Please make our undersranding based on above

Here’s a structured document summarizing your understanding of the project:

{"name": "klass_energy_overview", "type": "document", "content": "**Project Understanding Document**nn## 1. OverviewnKlass Energy operates multiple WordPress websites (11-12) focused on selling home heating oil, including kerosene and gas oil, across Ireland. The primary operational challenge is managing fluctuating fuel prices, which vary by county. To streamline price management and delivery restrictions, a CodeIgniter-based dashboard was developed. A custom WordPress plugin was also created to replace WooCommerce, ensuring a seamless checkout experience integrated with the pricing system.nn## 2. Hosting and Infrastructuren- **WordPress Websites**: Hosted on SiteGround.n- **CodeIgniter Dashboard**: Hosted on a shared server (server3.thenet.ie).n- **Database**: MySQL instances hosted on Hetzner, with a mirrored server for redundancy and firewall protection.nn## 3. Key Technologies & Architecturen- **Frontend**: WordPress with a custom plugin replacing WooCommerce.n- **Backend**: CodeIgniter dashboard for managing pricing, delivery dates, and orders.n- **Database**: MySQL hosted on Hetzner (primary and mirrored instances).n- **Payments**: Integrated with Global Payments, including 3D Secure authentication.n- **Email Notifications**: Sent via Freshdesk for admin alerts and order confirmations.nn## 4. System Functionalityn### 4.1 CodeIgniter Dashboard (Admin Panel)n- **Manage Pricing**: Admins can log in and update fuel prices for volumes between 100–1000L.n- **Delivery Restrictions**: Admins can restrict deliveries to certain areas and dates.n- **Order Management**: Orders can be viewed and updated from pending to completed.nn### 4.2 WordPress Plugin (Customer Checkout System)n- **Location-Based Pricing**: Fetches fuel prices dynamically from the CodeIgniter dashboard.n- **Checkout & Payment Processing**: Handles order submissions and payment through Global Payments.n- **Order Tracking**: Customers receive order confirmation emails, and admins are notified.nn## 5. Staging and Deployment Workflown- **Staging Server**: `klassenergy.thenet.ie` for testing before deployment.n- **Version Control**: Codebase is maintained on GitHub.n- **Deployment Process**: Changes are tested on staging, approved, pushed to GitHub, and then deployed to live sites.nn## 6. Security & Maintenance Considerationsn- **Firewall Protection**: Database access is restricted for security.n- **Regular Updates**: CodeIgniter and WordPress plugin updates are thoroughly tested before deployment.n- **Backup Strategy**: Redundant MySQL instance at Hetzner ensures data integrity and availability.nn## 7. Next Steps for the Development Teamn- **Familiarization**: Review the CodeIgniter dashboard and understand its integration with WordPress.n- **Repository Review**: Access and study the GitHub repository for codebase and deployment processes.n- **Testing Protocol**: Implement and test changes on the staging server before pushing updates to production.n- **Security Compliance**: Ensure all implementations align with Global Payments security protocols (3D Secure).nnThis document outlines our understanding of the project and the necessary steps for the development team to ensure smooth operation and enhancements moving forward."}

I've structured the document to clearly outline the project details, key technologies, functionalities, and next steps for the development team. Let me know if you'd like any modifications or additional details.