5.5 KiB
5.5 KiB
Feature Documentation
Welcome to the Changemaker Lite V2 feature documentation. This section provides end-to-end guides for complete features, showing how backend APIs, frontend pages, and database models work together to deliver functionality.
Documentation Structure
Each feature guide includes:
- Architecture diagrams showing data flow
- Database models with relationships
- API endpoints for admin and public access
- Configuration options and environment variables
- Workflows for admin, public, and volunteer users
- Code examples from actual source files
- Troubleshooting common issues
- Performance optimization tips
Feature Categories
Influence Features
Email advocacy campaigns and representative outreach:
- Campaign Management — Create and manage advocacy campaigns
- Representative Lookup — Postal code-based representative search
- Response Wall — Public response submission and moderation
- Email Queue — BullMQ email processing system
- Postal Code Cache — Postal code geocoding cache
Map Features
Geographic location management and canvassing:
- Location Management — Building and unit-level address management
- Geocoding — Multi-provider geocoding service
- Geographic Cuts — Polygon overlays for organizing locations
- Volunteer Shifts — Shift scheduling and signup system
- Canvassing System — Door-to-door canvassing with GPS
- GPS Tracking — Real-time volunteer location tracking
- Walk Sheets — Printable canvassing materials
- Data Quality Dashboard — Geocoding quality monitoring
- NAR Import — Canadian electoral data import
Landing Pages
Website page building and management:
- Page Builder — GrapesJS visual editor
- GrapesJS Editor Component — Editor integration
- Block Library — Reusable content blocks
- MkDocs Export — Export to documentation site
Email Templates
Email template system for campaigns:
- Template System — Email template engine
- Template Editor — HTML template editing
- Template Variables — Dynamic variable system
- Version History — Template version tracking
Media Features
Video library management:
- Video Library — Video organization and metadata
- Video Upload — Upload with automatic metadata extraction
- Media Jobs — Background job processing
- Public Gallery — Public video sharing
Newsletter Integration
Listmonk newsletter platform integration:
- Listmonk Integration — API client setup
- Data Sync — Sync contacts to Listmonk
- List Management — Newsletter list administration
Tunnel Management
Pangolin tunnel for public access:
- Pangolin Setup — Tunnel configuration
- Newt Container — Docker integration
- Exit Nodes — Exit node management
Observability
Monitoring and metrics:
- Prometheus Metrics — Custom metrics collection
- Grafana Dashboards — Visualization dashboards
- Alertmanager — Alert routing
- Data Quality Monitoring — Data quality tracking
Related Documentation
- Backend Modules — API implementation details
- Frontend Pages — UI component documentation
- Database Models — Schema documentation
- Architecture — System architecture guides
- User Guides — Step-by-step tutorials
Quick Navigation
By User Role
Administrators:
- Campaign creation and management
- Response moderation
- User management
- Location management
- Shift scheduling
- Email queue monitoring
- Landing page editing
Public Users:
- Campaign participation
- Representative lookup
- Email sending
- Response submission
- Shift signup
- Media gallery browsing
Volunteers:
- Canvassing with GPS
- Visit recording
- Shift assignments
- Activity tracking
- Route history
By Use Case
Advocacy Campaigns:
Canvassing Operations:
Website Management:
Public Access: