164 lines
6.3 KiB
Markdown
164 lines
6.3 KiB
Markdown
---
|
|
template: lander.html
|
|
hide:
|
|
- navigation
|
|
- toc
|
|
---
|
|
|
|
# Welcome to Changemaker Lite
|
|
|
|
Stop feeding your secrets to corporations. Own your political infrastructure.
|
|
|
|
!!! success "Changemaker Lite V2 is Now Available"
|
|
**V2 is a complete architectural rebuild** with a modern TypeScript stack, dual API design, React admin interface, and comprehensive feature modules. Production ready with security audit completed.
|
|
|
|
[→ Explore V2 Documentation](v2/index.md){ .md-button .md-button--primary }
|
|
[→ Quick Start Guide](v2/getting-started/quick-start.md){ .md-button }
|
|
|
|
## Changemaker Lite V2
|
|
|
|
V2 is the **recommended version** for all new installations. It offers:
|
|
|
|
### ✨ Modern Architecture
|
|
- **Dual API Design**: Express.js (main features) + Fastify (media library)
|
|
- **TypeScript Throughout**: Type-safe development with better IDE support
|
|
- **Prisma + Drizzle ORM**: Direct database access (no NocoDB middleware)
|
|
- **React Admin**: Modern UI with Vite + Ant Design + Zustand
|
|
|
|
### 🚀 Comprehensive Features
|
|
- **Influence Module**: Email advocacy campaigns targeting elected representatives
|
|
- **Map Module**: Geographic mapping with GPS-tracked canvassing
|
|
- **Landing Pages**: GrapesJS page builder with MkDocs export
|
|
- **Email Templates**: Template management system
|
|
- **Media Library**: Video management with public gallery
|
|
- **Newsletter Integration**: Listmonk sync for email marketing
|
|
- **Observability**: Prometheus + Grafana monitoring stack
|
|
|
|
### 🔒 Production Ready
|
|
- **Security Audited**: 13 findings addressed (Feb 2026)
|
|
- **JWT Authentication**: Role-based access control with refresh tokens
|
|
- **Password Policy**: Enforced complexity requirements
|
|
- **Rate Limiting**: Per-endpoint protection
|
|
- **Monitoring**: 12 custom metrics + 3 Grafana dashboards
|
|
|
|
### 📚 Complete Documentation
|
|
- [Getting Started](v2/getting-started/index.md) - Installation and setup
|
|
- [Architecture](v2/architecture/index.md) - System design and components
|
|
- [Features](v2/features/index.md) - Module documentation
|
|
- [API Reference](v2/api-reference/index.md) - Complete endpoint docs
|
|
- [User Guides](v2/user-guides/index.md) - Role-based manuals
|
|
|
|
[**Explore V2 Documentation →**](v2/index.md)
|
|
|
|
---
|
|
|
|
## Changemaker Lite V1 (Legacy)
|
|
|
|
!!! warning "V1 is Deprecated"
|
|
V1 documentation is preserved below for reference. **We strongly recommend migrating to V2** for improved performance, security, and features.
|
|
|
|
[→ View Migration Guide](v2/migration/index.md)
|
|
|
|
### Quick Start (V1)
|
|
|
|
Get V1 running in minutes:
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://gitea.bnkops.com/admin/changemaker.lite
|
|
cd changemaker.lite
|
|
|
|
# Configure environment
|
|
./config.sh
|
|
|
|
# Start all services
|
|
docker compose up -d
|
|
|
|
# For production deployment with Cloudflare tunnels
|
|
./start-production.sh
|
|
```
|
|
|
|
## Services
|
|
|
|
Changemaker Lite includes these essential services:
|
|
|
|
### Core Services
|
|
|
|
- **[Homepage](v1/services/homepage.md)** (Port 3010) - Central dashboard and service monitoring
|
|
- **[Code Server](v1/services/code-server.md)** (Port 8888) - VS Code in your browser
|
|
- **[MkDocs](v1/services/mkdocs.md)** (Port 4000) - Documentation with live preview
|
|
- **[Static Server](v1/services/static-server.md)** (Port 4001) - Production documentation site
|
|
|
|
### Communication & Automation
|
|
|
|
- **[Listmonk](v1/services/listmonk.md)** (Port 9000) - Newsletter and email campaign management
|
|
- **[n8n](v1/services/n8n.md)** (Port 5678) - Workflow automation platform
|
|
|
|
### Data & Development
|
|
|
|
- **[NocoDB](v1/services/nocodb.md)** (Port 8090) - No-code database platform
|
|
- **[PostgreSQL](v1/services/postgresql.md)** (Port 5432) - Database backend for Listmonk
|
|
- **[Gitea](v1/services/gitea.md)** (Port 3030) - Self-hosted Git service
|
|
|
|
### Interactive Tools
|
|
|
|
- **[Map Viewer](v1/services/map.md)** (Port 3000) - Interactive map with NocoDB integration
|
|
- **[Mini QR](v1/services/mini-qr.md)** (Port 8089) - QR code generator
|
|
|
|
## Getting Started (V1)
|
|
|
|
1. **Setup**: Run `./config.sh` to configure your environment
|
|
2. **Launch**: Start services with `docker compose up -d`
|
|
3. **Dashboard**: Access the Homepage at [http://localhost:3010](http://localhost:3010)
|
|
4. **Production**: Deploy with Cloudflare tunnels using `./start-production.sh`
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
changemaker.lite/
|
|
├── docker-compose.yml # Service definitions
|
|
├── config.sh # Configuration wizard
|
|
├── start-production.sh # Production deployment script
|
|
├── mkdocs/ # Documentation source
|
|
│ ├── docs/ # Markdown files
|
|
│ └── mkdocs.yml # MkDocs configuration
|
|
├── configs/ # Service configurations
|
|
│ ├── homepage/ # Homepage dashboard config
|
|
│ ├── code-server/ # VS Code settings
|
|
│ └── cloudflare/ # Tunnel configurations
|
|
├── map/ # Map application
|
|
│ ├── app/ # Node.js application
|
|
│ ├── Dockerfile # Container definition
|
|
│ └── .env # Map configuration
|
|
└── assets/ # Shared assets
|
|
├── images/ # Image files
|
|
├── icons/ # Service icons
|
|
└── uploads/ # Listmonk uploads
|
|
```
|
|
|
|
## Key Features
|
|
|
|
- 🐳 **Fully Containerized** - All services run in Docker containers
|
|
- 🔒 **Production Ready** - Built-in Cloudflare tunnel support for secure access
|
|
- 📦 **All-in-One** - Everything you need for documentation, development, and campaigns
|
|
- 🗺️ **Geographic Data** - Interactive maps with real-time location tracking
|
|
- 📧 **Email Campaigns** - Professional newsletter management
|
|
- 🔄 **Automation** - Connect services and automate workflows
|
|
- 💾 **Version Control** - Self-hosted Git repository
|
|
- 🎯 **No-Code Database** - Build applications without programming
|
|
|
|
## System Requirements
|
|
|
|
- **OS**: Ubuntu 24.04 LTS (Noble Numbat) or compatible Linux distribution
|
|
- **Docker**: Version 24.0+ with Docker Compose v2
|
|
- **Memory**: Minimum 4GB RAM (8GB recommended)
|
|
- **Storage**: 20GB+ available disk space
|
|
- **Network**: Internet connection for initial setup
|
|
|
|
## Learn More (V1)
|
|
|
|
- [Getting Started](v1/build/index.md) - Detailed installation guide
|
|
- [Services Overview](v1/services/index.md) - Deep dive into each service
|
|
- [Blog](blog/index.md) - Updates and tutorials
|
|
- [GitHub Repository](https://gitea.bnkops.com/admin/Changemaker) - Source code
|