Skip to content

User Guides

This section provides step-by-step guides for different user roles and common tasks. Each guide is tailored to specific workflows and responsibilities.

Role-Based Guides

Admin Guide

For system administrators and site managers:

  • Initial setup and configuration
  • User management
  • Site settings
  • Service integration
  • Monitoring and maintenance
  • Security best practices

Target Audience: SUPER_ADMIN role

Campaign Manager Guide

For advocacy campaign coordinators:

  • Creating campaigns
  • Managing representatives
  • Email template design
  • Response moderation
  • Campaign analytics
  • Email queue monitoring

Target Audience: INFLUENCE_ADMIN role

Map Organizer Guide

For field organizing coordinators:

  • Location management
  • Importing data (CSV, NAR)
  • Creating geographic cuts
  • Scheduling volunteer shifts
  • Monitoring canvassing progress
  • Printing walk sheets

Target Audience: MAP_ADMIN role

Volunteer Guide

For field canvassers:

  • Viewing shift assignments
  • Starting canvass session
  • Using GPS map
  • Recording visit outcomes
  • Tracking personal activity
  • Best practices for canvassing

Target Audience: USER role

Content Editor Guide

For content creators:

  • Creating landing pages
  • Using GrapesJS editor
  • Email template creation
  • Managing media library
  • Publishing content
  • SEO best practices

Target Audience: SUPER_ADMIN role

Common Tasks

Getting Started

  1. First Login
  2. Navigate to http://your-domain.com or http://localhost:3000
  3. Login with credentials
  4. Change default password

  5. Explore dashboard

  6. User Role Redirection

  7. Admin roles → /app/dashboard
  8. User/volunteer roles → /volunteer/dashboard

Campaign Workflow

  1. Create Campaign
  2. Navigate to /app/influence/campaigns
  3. Click "New Campaign"
  4. Fill in details

  5. Save campaign

  6. Design Email Template

  7. Set email subject
  8. Write email body
  9. Use variable placeholders

  10. Preview template

  11. Launch Campaign

  12. Set to published
  13. Share public URL
  14. Monitor responses

Location Workflow

  1. Import Locations
  2. Prepare CSV file
  3. Navigate to /app/map/locations
  4. Click "Import CSV"
  5. Map columns

  6. Import data

  7. Geocode Addresses

  8. Select ungeocode locations
  9. Click "Geocode Selected"
  10. Monitor progress

  11. Review quality metrics

  12. Create Geographic Cuts

  13. Navigate to /app/map/cuts
  14. Click "Draw on Map"
  15. Draw polygon
  16. Save cut
  17. Assign locations

Volunteer Canvassing Workflow

  1. View Assignments
  2. Login as volunteer
  3. Navigate to /volunteer/assignments

  4. View upcoming shifts

  5. Start Canvassing

  6. Click "Start Canvass"
  7. Grant GPS permissions
  8. Follow walking route

  9. Visit locations

  10. Record Visits

  11. Click location marker
  12. Select outcome
  13. Add notes

  14. Submit

  15. End Session

  16. Click "End Session"
  17. Review statistics
  18. View in activity history

Task Guides

Import Canadian Electoral Data (NAR)

  1. Prepare Data
  2. Download NAR 2025 data
  3. Place in /data directory

  4. Ensure Address + Location files present

  5. Import via Admin

  6. Navigate to /app/map/locations
  7. Click "Import NAR"
  8. Select province
  9. Apply filters

  10. Start import

  11. Review Import

  12. Check location count
  13. Verify geocoding
  14. Review quality dashboard

Set Up Public Campaign Page

  1. Create Campaign
  2. Configure targeting (federal/provincial)
  3. Write email template

  4. Set to published

  5. Share URL

  6. Copy public URL: /campaigns/:id
  7. Share on social media

  8. Embed in website

  9. Monitor Engagement

  10. View email statistics
  11. Moderate responses
  12. Check response wall

Configure Newsletter Sync

  1. Enable Listmonk
  2. Set LISTMONK_SYNC_ENABLED=true
  3. Configure API credentials

  4. Restart services

  5. Initialize Sync

  6. Navigate to /app/services/listmonk
  7. Click "Test Connection"

  8. Click "Sync Participants"

  9. Manage Lists

  10. View list statistics
  11. Configure sync settings
  12. Monitor sync status

Set Up Public Tunnel

  1. Create Pangolin Account
  2. Sign up at pangolin.bnkserve.org

  3. Generate API key

  4. Configure Tunnel

  5. Navigate to /app/services/pangolin
  6. Enter API key
  7. Follow setup wizard

  8. Deploy Newt container

  9. Test Public Access

  10. Visit public URL
  11. Verify subdomain routing
  12. Check SSL/TLS

Create Landing Page

  1. Start New Page
  2. Navigate to /app/pages
  3. Click "New Page"

  4. Enter title and slug

  5. Design Page

  6. Click "Edit"
  7. Use GrapesJS editor
  8. Drag blocks
  9. Customize content

  10. Save (Ctrl+S)

  11. Publish

  12. Set to published
  13. View at /p/:slug
  14. Share URL

Best Practices

Campaign Management

  • Use clear, action-oriented language
  • Test email templates before launch
  • Monitor response rates
  • Moderate responses promptly
  • Follow up with engaged supporters

Field Organizing

  • Clean location data before import
  • Create manageable cut sizes (100-200 locations)
  • Assign volunteers to familiar areas
  • Print walk sheets in advance
  • Review canvass progress daily

Content Creation

  • Write mobile-responsive pages
  • Use SEO-friendly titles and descriptions
  • Test pages on multiple devices
  • Keep content concise
  • Include clear calls-to-action

System Administration

  • Change default passwords immediately
  • Enable monitoring stack
  • Set up automated backups
  • Review security audit findings
  • Keep services updated

Mobile Usage

Volunteer Canvassing

Best on mobile devices:

  • Full-screen map
  • GPS tracking
  • Touch-friendly controls
  • Offline support (future)

Admin Tasks

Best on desktop:

  • Content editing (GrapesJS, email templates)
  • Data import/export
  • Configuration
  • Monitoring dashboards

Keyboard Shortcuts

Page Editor

  • Ctrl+S - Save page
  • Ctrl+Z - Undo
  • Ctrl+Y - Redo

General

  • / - Focus search (tables)
  • Esc - Close modal/drawer