Docker

What is Klask?

🚀 Modern Architecture (v2.x)

Backend

Frontend

Features

📦 Quick Start

Local Development (Docker Compose)

# Clone the repositorygit clone https://github.com/klask-dev/klask-dev.gitcd klask-dev# Start all services with docker-composedocker-compose up -d# Access Klask at http://localhost:5173# Backend API at http://localhost:3000

Manual Development Setup

Prerequisites

1. Start PostgreSQL Database

# Using Docker (recommended)docker-compose -f docker-compose.dev.yml up -d# Or use your own PostgreSQL instance# Make sure to create a database named 'klask'

2. Start Backend (Rust)

cd klask-rs# Install dependencies and run migrationscargo buildsqlx migrate run# Start the backend servercargo run --bin klask-rs# Backend will be available at http://localhost:3000

3. Start Frontend (React)

cd klask-react# Install dependenciesnpm install# Start the development servernpm run dev# Frontend will be available at http://localhost:5173

🐳 Docker Deployment

Docker Compose (Production)

# Pull and start servicesdocker-compose up -d# View logsdocker-compose logs -f# Stop servicesdocker-compose down

Docker Images

# Backenddocker pull klask/klask-backend:latestdocker run -p 3000:3000 -e DATABASE_URL=postgres://... klask/klask-backend:latest# Frontenddocker pull klask/klask-frontend:latestdocker run -p 5173:80 klask/klask-frontend:latest

☸️ Kubernetes Deployment (Helm)

Quick Install

# Add Klask Helm repository (if available)helm repo add klask https://charts.klask.devhelm repo update# Install with default valueshelm install klask klask/klask# Install with custom valueshelm install klask klask/klask -f my-values.yaml

Basic Configuration Example

backend:replicaCount:2image:repository:klask/klask-backendtag:"2.1.0"resources:requests:memory:"512Mi"cpu:"500m"limits:memory:"1Gi"cpu:"1000m"frontend:replicaCount:2image:repository:klask/klask-frontendtag:"2.1.0"postgresql:enabled:trueauth:username:klaskpassword:changemedatabase:klaskingress:enabled:trueclassName:nginxhosts:    -host:klask.example.compaths:        -path:/pathType:Prefixtls:    -secretName:klask-tlshosts:        -klask.example.com

helm install klask ./charts/klask -f values.yaml

🛠️ Development

Project Structure

klask-dev/├── klask-rs/           # Rust backend (Axum + Tantivy + PostgreSQL)│   ├── src/│   │   ├── api/        # REST API endpoints│   │   ├── models/     # Database models│   │   ├── services/   # Business logic (crawler, search, etc.)│   │   └── repositories/ # Database queries│   ├── migrations/     # SQL migrations (SQLx)│   └── Cargo.toml│├── klask-react/        # React frontend (TypeScript + Vite + TailwindCSS)│   ├── src/│   │   ├── api/        # API client (React Query)│   │   ├── components/ # Reusable UI components│   │   ├── features/   # Feature modules (search, admin, etc.)│   │   └── hooks/      # Custom React hooks│   └── package.json│├── charts/klask/       # Helm chart for Kubernetes deployment├── .claude/            # AI-assisted development tools└── docker-compose.yml  # Local development environment

Running Tests

# Backend tests (Rust)cd klask-rscargotest# Frontend tests (React)cd klask-reactnpmtest# Integration testsnpm run test:integration

Building for Production

# Backendcd klask-rscargo build --release# Frontendcd klask-reactnpm run build# Docker imagesdocker build -t klask/klask-backend:latest -f klask-rs/Dockerfile.docker build -t klask/klask-frontend:latest -f klask-react/Dockerfile.

📚 Documentation

🤝 Contributing

Development Workflow

📄 License

🔗 Links

🙏 Acknowledgments