142 lines
No EOL
4.3 KiB
Markdown
142 lines
No EOL
4.3 KiB
Markdown
# Project Brief: HVAC Community Events Management System
|
|
|
|
**Status**: Active Development
|
|
**Last Updated**: 2025-03-25 08:51:21
|
|
**Project Type**: WordPress Plugin Development
|
|
|
|
## Project Overview
|
|
|
|
The HVAC Community Events Management System is a specialized WordPress plugin that extends The Events Calendar suite to create a comprehensive platform for HVAC trainers. The system enables independent trainers to manage their own events, sell tickets, and track performance without accessing the WordPress admin panel.
|
|
|
|
## Core Objectives
|
|
|
|
1. Create a user-friendly platform for HVAC trainers to manage training events
|
|
2. Provide comprehensive event management capabilities
|
|
3. Enable ticket sales and attendee tracking
|
|
4. Implement performance monitoring and reporting
|
|
5. Ensure seamless integration with existing WordPress infrastructure
|
|
|
|
## Development Philosophy
|
|
|
|
The project follows a lean development approach by maximizing the use of existing functionality:
|
|
|
|
1. **WordPress Core Integration**
|
|
- Utilize WordPress user management system
|
|
- Leverage WordPress roles and capabilities
|
|
- Use WordPress hooks and filters
|
|
- Take advantage of WordPress REST API
|
|
|
|
2. **The Events Calendar Suite Integration**
|
|
- Build upon existing event management features
|
|
- Utilize built-in ticket management system
|
|
- Leverage existing attendee tracking
|
|
- Use provided template system
|
|
- Extend existing shortcodes and widgets
|
|
|
|
3. **Custom Development Focus**
|
|
- Only build custom features when existing functionality cannot be extended
|
|
- Maintain compatibility with parent plugins
|
|
- Follow WordPress and The Events Calendar coding standards
|
|
- Ensure upgradability of parent plugins
|
|
|
|
## User Journeys
|
|
|
|
### Trainer Journey
|
|
1. Register through Trainer Registration Page
|
|
2. Log in through Community Login page
|
|
3. Access personalized Dashboard
|
|
4. Create and manage events
|
|
5. View order details
|
|
6. Access attendee information
|
|
7. Communicate with attendees
|
|
8. Perform attendee Check-In
|
|
9. Generate completion certificates (Phase 3)
|
|
|
|
### Trainee Journey
|
|
1. View Upskill HVAC website
|
|
2. Browse Training Events
|
|
3. Register for events
|
|
4. Attend events
|
|
5. Receive completion certificates (Phase 3)
|
|
6. Access personal training history (Phase 3)
|
|
7. Request additional training (Phase 3)
|
|
|
|
## Technical Requirements
|
|
|
|
### WordPress Environment
|
|
- WordPress 5.9+
|
|
- PHP 7.4+
|
|
|
|
### Required Plugins
|
|
1. The Events Calendar Suite:
|
|
- The Events Calendar (6.10.2+)
|
|
- Events Calendar Pro (7.4.2+)
|
|
- Event Tickets (5.19.3+)
|
|
- Event Tickets Plus (6.2.0+)
|
|
- Community Events (4.10.0+)
|
|
2. Additional Plugins:
|
|
- Spectra Pro (2.0.0+)
|
|
- Premium Starter Templates (4.4.14+)
|
|
- Essential Blocks (5.3.2+)
|
|
|
|
## Implementation Phases
|
|
|
|
### Phase 1: Core Functionality
|
|
- Community Registration Page
|
|
- Community Login Page
|
|
- Trainer Profile Page
|
|
- Basic Dashboard
|
|
- Event Creation/Management
|
|
- Event Summary Page
|
|
|
|
### Phase 2: Enhanced Features
|
|
- Zoho CRM API Integration
|
|
- Email Attendees functionality
|
|
- Enhanced event management
|
|
- Comprehensive transaction reporting
|
|
|
|
### Phase 3: Advanced Features
|
|
- Certificate generation system
|
|
- Request Training Page
|
|
- My Training Page
|
|
- Advanced reporting capabilities
|
|
|
|
## Technical Considerations
|
|
|
|
### Development Approach
|
|
- Leverage existing WordPress and The Events Calendar functions whenever possible
|
|
- Extend rather than replace existing functionality
|
|
- Implement containerized development environment
|
|
- Comprehensive testing framework
|
|
- Security-first implementation
|
|
|
|
### Testing Framework
|
|
- Playwright-based automated testing
|
|
- Cross-browser compatibility
|
|
- Mobile device emulation
|
|
- Comprehensive test reporting
|
|
|
|
### User Interface Guidelines
|
|
- Consistent navigation structure
|
|
- Mobile-friendly, responsive design
|
|
- Accessible color choices
|
|
- Theme compatibility
|
|
- Gutenberg editor compatibility
|
|
|
|
## Security Requirements
|
|
|
|
1. Input validation and sanitization
|
|
2. User capability verification
|
|
3. Protection against common vulnerabilities
|
|
4. Secure data handling
|
|
5. Role-based access control
|
|
|
|
## Success Criteria
|
|
|
|
1. Successful trainer registration and event management
|
|
2. Accurate ticket sales and attendee tracking
|
|
3. Reliable reporting and performance metrics
|
|
4. Positive user feedback from trainers and trainees
|
|
5. Seamless integration with existing systems
|
|
|
|
2025-03-25 08:51:21 - Updated to emphasize integration with existing functionality |