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:

Map Features

Geographic location management and canvassing:

Landing Pages

Website page building and management:

Email Templates

Email template system for campaigns:

Media Features

Video library management:

Newsletter Integration

Listmonk newsletter platform integration:

Tunnel Management

Pangolin tunnel for public access:

Observability

Monitoring and metrics:

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:

  1. Create campaign
  2. Configure representatives
  3. Monitor email queue
  4. Moderate responses

Canvassing Operations:

  1. Import locations
  2. Create geographic cuts
  3. Schedule shifts
  4. Track canvassing
  5. Print walk sheets

Website Management:

  1. Build landing pages
  2. Manage content blocks
  3. Export to MkDocs

Public Access:

  1. Setup Pangolin tunnel
  2. Configure Newt container
  3. Monitor with observability