Quick Start¶

Get Loryth Butterfly running locally with Docker Compose.

Prerequisites¶

1. Clone the Repository¶

git clone <repository-url>
cd loryth-butterfly

2. Run the Setup Script¶

./docker-setup.sh

This script will:

Verify Docker installation
Create .env file from the template
Build all Docker images
Start all services
Wait for health checks to pass

Manual Setup¶

If you prefer to set things up manually:

cp .env.example .env    # Create environment config
docker compose build    # Build all images
docker compose up -d    # Start all services

3. Verify Services¶

# Check all containers are running
docker compose ps

# Test gateway health
curl http://localhost/health

# Test a service via gateway
curl http://localhost/api/v1/grocery/health

4. Access the Application¶

Service	URL
Web UI	http://localhost
API Gateway	http://localhost/api/v1
RabbitMQ Management	http://localhost:15672 (dev only)
MinIO Console	http://localhost:9001 (dev only)

Default Credentials (Development)¶

Service	Username	Password
PostgreSQL	`loryth`	`loryth`
RabbitMQ	`loryth`	`loryth`
MinIO	`loryth_access_key`	`loryth_secret_key`

Next Steps¶

See the Docker Guide for development workflows, production deployment, commands reference, and troubleshooting.
Read the Vision to understand the project goals.
Explore the Roadmap to see what's being worked on.