admin/freealberta
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
freealberta/mkdocs/docs/index.md

4.0 KiB
Raw Blame History

template, hide
template hide
home.html
navigation
toc

Welcome to Changemaker Lite

Stop feeding your secrets to corporations. Own your political infrastructure.

Quick Start

Get up and running in minutes:

# 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 (Port 3010) - Central dashboard and service monitoring
  • Code Server (Port 8888) - VS Code in your browser
  • MkDocs (Port 4000) - Documentation with live preview
  • Static Server (Port 4001) - Production documentation site

Communication & Automation

  • Listmonk (Port 9000) - Newsletter and email campaign management
  • n8n (Port 5678) - Workflow automation platform

Data & Development

  • NocoDB (Port 8090) - No-code database platform
  • PostgreSQL (Port 5432) - Database backend for Listmonk
  • Gitea (Port 3030) - Self-hosted Git service

Interactive Tools

  • Map Viewer (Port 3000) - Interactive map with NocoDB integration
  • Mini QR (Port 8089) - QR code generator

Getting Started

  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
  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