62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# Changemaker Lite
|
|
|
|
Changemaker Lite is a streamlined documentation and development platform featuring essential self-hosted services for creating, managing, and automating political campaign workflows.
|
|
|
|
## Features
|
|
|
|
- **Homepage**: Modern dashboard for accessing all services
|
|
- **Code Server**: VS Code in your browser for remote development
|
|
- **MkDocs Material**: Beautiful documentation with live preview
|
|
- **Static Site Server**: High-performance hosting for built sites
|
|
- **Listmonk**: Self-hosted newsletter and email campaign management
|
|
- **PostgreSQL**: Reliable database backend
|
|
- **n8n**: Workflow automation and service integration
|
|
- **NocoDB**: No-code database platform and smart spreadsheet interface
|
|
- **Map**: Interactive map visualization for geographic data with real-time geolocation, walk sheet generation, and QR code integration
|
|
|
|
## Quick Start
|
|
|
|
The whole system can be set up in minutes using Docker Compose. It is recommended to run this on a server with at least 8GB of RAM and 4 CPU cores for optimal performance. Instructions to build to production are available in the mkdocs/docs/build directory, at cmlite.org, or in the site preview.
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://gitea.bnkops.com/admin/changemaker.lite
|
|
cd changemaker.lite
|
|
|
|
# Configure environment (creates .env file)
|
|
./config.sh
|
|
|
|
# Start all services
|
|
docker compose up -d
|
|
```
|
|
|
|
## Map & Production
|
|
|
|
Instructions on how to build the map are available in the map directory.
|
|
|
|
Instructions on how to build for production are available in the mkdocs/docs/build directory or in the site preview.
|
|
|
|
## Service Access
|
|
|
|
After starting, access services at:
|
|
|
|
- **Homepage Dashboard**: http://localhost:3010
|
|
- **Documentation (Dev)**: http://localhost:4000
|
|
- **Documentation (Built)**: http://localhost:4001
|
|
- **Code Server**: http://localhost:8888
|
|
- **Listmonk**: http://localhost:9000
|
|
- **n8n**: http://localhost:5678
|
|
- **NocoDB**: http://localhost:8090
|
|
- **Map Viewer**: http://localhost:3000
|
|
|
|
## Documentation
|
|
|
|
Complete documentation is available in the MkDocs site, including:
|
|
|
|
- Service configuration guides
|
|
- Integration examples
|
|
- Workflow automation tutorials
|
|
- Map application setup and usage
|
|
- Troubleshooting guides
|
|
|
|
Visit http://localhost:4000 after starting services to access the full documentation. |