61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
# Welcome to Changemaker Lite
|
|
|
|
A streamlined, self-hosted platform for documentation and development.
|
|
|
|
## Quick Start
|
|
|
|
Get up and running in minutes:
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://gitea.bnkops.com/admin/Changemaker.git
|
|
cd changemaker.lite
|
|
|
|
# Configure environment
|
|
./config.sh
|
|
|
|
# Start all services
|
|
docker compose up -d
|
|
```
|
|
|
|
## Services
|
|
|
|
Changemaker Lite includes these essential services:
|
|
|
|
- **[Homepage](services/homepage.md)** (Port 3010) - Service dashboard and monitoring
|
|
- **[Code Server](services/code-server.md)** (Port 8888) - VS Code in your browser
|
|
- **[MkDocs](services/mkdocs.md)** (Port 4000) - Documentation with live preview
|
|
- **[Static Server](services/static-server.md)** (Port 4001) - Built site hosting
|
|
- **[Waypoint Editor](services/waypoint-editor.md)** (Port 3020) - Visual page editor
|
|
- **[Listmonk](services/listmonk.md)** (Port 9000) - Newsletter management
|
|
- **[PostgreSQL](services/postgresql.md)** (Port 5432) - Database backend
|
|
- **[n8n](services/n8n.md)** (Port 5678) - Workflow automation
|
|
- **[NocoDB](services/nocodb.md)** (Port 8090) - No-code database platform
|
|
|
|
## Getting Started
|
|
|
|
1. **Documentation**: Start writing in [Code Server](http://localhost:8888)
|
|
2. **Preview**: See live changes at [MkDocs](http://localhost:4000)
|
|
3. **Production**: View built site at [Static Server](http://localhost:4001)
|
|
4. **Email**: Set up campaigns with [Listmonk](http://localhost:9000)
|
|
5. **Automation**: Create workflows in [n8n](http://localhost:5678)
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
changemaker.lite/
|
|
├── docker-compose.yml # Service definitions
|
|
├── config.sh # Setup script
|
|
├── mkdocs/ # Documentation source
|
|
│ ├── docs/ # Markdown files
|
|
│ └── mkdocs.yml # Configuration
|
|
├── configs/ # Service configurations
|
|
└── assets/ # Shared assets
|
|
```
|
|
|
|
## Learn More
|
|
|
|
- [Services Overview](services/index.md) - Detailed service documentation
|
|
- [Blog](blog/index.md) - Updates and tutorials
|
|
- [GitHub Repository](https://gitea.bnkops.com/admin/Changemaker) - Source code and issues
|