Documentation¶
Welcome to the Changemaker Lite documentation. Whether you're a campaign volunteer, an admin managing operations, or a sysadmin deploying the platform — start here.
Use the Platform¶
-
Getting Started
Install Changemaker Lite, create your first admin account, and explore the dashboard.
-
Feature Guides
Campaigns, email advocacy, response walls, map locations, landing pages, and media.
-
Administration
User management, roles and permissions, site settings, email templates, and newsletters.
-
Volunteer Guide
Sign up for shifts, use the canvassing map, record visits, and track your activity.
Deploy & Operate¶
-
Deployment
Docker Compose setup, environment variables, SSL/TLS, backups, and production checklist.
-
Architecture
Dual API design, database schema, authentication flow, and system diagram.
-
Services
Nginx routing, Redis, PostgreSQL, Listmonk, MkDocs, Gitea, NocoDB, and more.
-
Monitoring
Prometheus metrics, Grafana dashboards, Alertmanager rules, and health checks.
Monitoring Coming soon
Reference¶
-
API Reference
REST endpoints for auth, campaigns, locations, shifts, media, and more.
-
Troubleshooting
Common errors, CORS issues, database problems, tunnel debugging, and FAQ.
-
Security
Password policy, rate limiting, token rotation, encryption, and audit report.
Security See Deployment
-
Contributing
Development setup, code style, git workflow, and pull request guidelines.
Contributing Coming soon
Platform at a Glance¶
| Component | Technology | Purpose |
|---|---|---|
| Main API | Express.js + Prisma | Auth, campaigns, map, shifts, pages, email |
| Media API | Fastify + Prisma | Video library, analytics, upload, scheduling |
| Admin GUI | React + Ant Design + Zustand | Dashboard for admins and organizers |
| Database | PostgreSQL 16 | Single shared database for both APIs |
| Cache | Redis | Rate limiting, BullMQ jobs, geocoding queue |
| Proxy | Nginx | Subdomain routing, security headers, SSL |
| Tunnel | Pangolin + Newt | Expose services without port forwarding |
| Monitoring | Prometheus + Grafana | Metrics, dashboards, alerts |
New here?
Start with the Getting Started guide to have the platform running in under 30 minutes.
Looking for the source?
Changemaker Lite is 100% open source. Browse the code on Gitea.