🐨 Koala Platform

A modern monorepo boilerplate built for scalable fullstack applications.
This project combines Ruby on Rails, React + TypeScript, Kafka, Redis, and PostgreSQL, with support for Docker, CI/CD, and microservices.

🗓️ Last updated: 2025-06-28

---

🔧 Tech Stack

Layer	Tech
Backend	Ruby on Rails 7 (API-only)
Frontend	React + TypeScript (Vite)
Messaging	Kafka (Bitnami, PLAINTEXT)
Cache	Redis
Database	PostgreSQL 15
Log Service	Node.js + KafkaJS
Orchestration	Docker Compose
Gateway	Traefik (planned)
CI/CD	GitHub Actions (planned)

---

📦 Folder Structure

├── apps/
│   ├── backend/        # Ruby on Rails app
│   ├── frontend/       # React app (Vite)
│   └── log-service/    # Node.js service for Kafka logs
├── docker/             # Configs for nginx, traefik etc.
├── .env, .env.\*        # Environment files
├── docker-compose.yml
└── README.md

🚀 Getting Started (Development)

# Clone the repo
git clone https://github.com/yourusername/koala-platform.git
cd koala-platform

# Start all services
docker-compose up --build

🔗 Local URLs

Сервіс	Посилання	Примітка
🛠️ Backend API	http://localhost:3000	Rails API-only backend
💻 Frontend	http://localhost:4173	Vite + React
🐘 PostgreSQL	localhost:5432	DB доступ через psql / PG GUI
🧠 Redis	localhost:6379	Cache, rate limiting
🧾 Swagger UI	http://localhost:3000/api-docs	Rswag (якщо підключено)
📜 Log Metrics	http://localhost:9100/metrics	Prometheus endpoint log-service
📈 Prometheus	http://localhost:9090	Збір метрик
📊 Grafana	http://localhost:3001	Візуалізація, логін: admin:admin

---

⚠️ Примітка

• Всі сервіси запускаються локально через docker-compose
• Паролі, логіни і порти конфігуруються через .env файли

---

✅ Implemented

• Rails + React monorepo via Docker
• Kafka setup (Bitnami image, PLAINTEXT)
• Kafka log producer from Rails
• Node.js log service consumer
• Retry logic for Kafka producer
• Middleware logging all HTTP requests
• Graceful shutdown on SIGTERM

---

🛠 TODO

🔐 Auth

• Add JWT/Auth0 authentication
• Protect APIs and emit login/signup events

🧪 Tests

• Unit + integration tests
• Kafka mock layer for test env

🌐 API Docs

• Swagger/OpenAPI via rswag

📊 Observability

• JSON logs with metadata
• Kafka → S3 or Elastic (optional)

🚢 DevOps

• GitHub Actions CI/CD
• Traefik reverse proxy + HTTPS (Let's Encrypt)
• .env.production and deploy scripts

---

📝 License

MIT © 2025 Koala Contributors