4.2 KiB
title, description, icon, tags, search
| title | description | icon | tags | search | ||||
|---|---|---|---|---|---|---|---|---|
| Documentation | Changemaker Lite documentation hub — guides for users, admins, and operators. | material/book-open-variant |
|
|
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
-
:material-rocket-launch:{ .lg .middle } Getting Started
Install Changemaker Lite, create your first admin account, and explore the dashboard.
-
:material-star-shooting:{ .lg .middle } Feature Guides
Campaigns, email advocacy, response walls, map locations, landing pages, and media.
-
:material-shield-account:{ .lg .middle } Administration
User management, roles and permissions, site settings, email templates, and newsletters.
-
:material-walk:{ .lg .middle } Volunteer Guide
Sign up for shifts, use the canvassing map, record visits, and track your activity.
Deploy & Operate
-
:material-docker:{ .lg .middle } Deployment
Docker Compose setup, environment variables, SSL/TLS, backups, and production checklist.
-
:material-sitemap:{ .lg .middle } Architecture
Dual API design, database schema, authentication flow, and system diagram.
-
:material-server-network:{ .lg .middle } Services
Nginx routing, Redis, PostgreSQL, Listmonk, MkDocs, Gitea, NocoDB, and more.
-
:material-chart-line:{ .lg .middle } Monitoring
Prometheus metrics, Grafana dashboards, Alertmanager rules, and health checks.
Reference
-
:material-api:{ .lg .middle } API Reference
REST endpoints for auth, campaigns, locations, shifts, media, and more.
-
:material-bug:{ .lg .middle } Troubleshooting
Common errors, CORS issues, database problems, tunnel debugging, and FAQ.
-
:material-lock-check:{ .lg .middle } Security
Password policy, rate limiting, token rotation, encryption, and audit report.
-
:material-source-pull:{ .lg .middle } Contributing
Development setup, code style, git workflow, and pull request guidelines.
:octicons-arrow-right-24: Contributing{ target="_blank" }
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 |
!!! tip "New here?" Start with the Getting Started guide to have the platform running in under 30 minutes.
!!! info "Looking for the source?" Changemaker Lite is 100% open source. Browse the code on Gitea.