Files
konstruct/.planning/PROJECT.md
Adolfo Delorenzo f1b79dffe0
Some checks failed
CI / Backend Tests (push) Has been cancelled
CI / Portal E2E (push) Has been cancelled
docs: update PROJECT.md, add README.md and CHANGELOG.md
- PROJECT.md updated to reflect v1.0 completion (10 phases, 39 plans,
  67 requirements). All key decisions marked as shipped.
- README.md: comprehensive project documentation with quick start,
  architecture, tech stack, configuration, and project structure.
- CHANGELOG.md: detailed changelog covering all 10 phases with
  feature descriptions organized by phase.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-26 09:37:55 -06:00

76 lines
3.9 KiB
Markdown

# Konstruct
## What This Is
Konstruct is an AI workforce platform where SMBs subscribe to AI employees that communicate through familiar messaging channels — Slack, WhatsApp, and the built-in web chat. Clients get AI workers that show up where their team already communicates, requiring zero behavior change. Think "hire an AI department" rather than "subscribe to another SaaS dashboard."
## Core Value
An AI employee that works in the channels your team already uses — no new tools to learn, no dashboards to check, just a capable coworker in Slack, WhatsApp, or the portal chat.
## Current State (v1.0 — Beta-Ready)
All 10 phases complete. 39 plans executed. 67 requirements satisfied.
### What's Shipped
| Feature | Status |
|---------|--------|
| Channel Gateway (Slack + WhatsApp + Web Chat) | ✓ Complete |
| Multi-tenant isolation (PostgreSQL RLS) | ✓ Complete |
| LLM Backend (Ollama + Anthropic/OpenAI via LiteLLM) | ✓ Complete |
| Conversational memory (Redis sliding window + pgvector) | ✓ Complete |
| Tool framework (web search, KB, HTTP, calendar) | ✓ Complete |
| Knowledge base (document upload, URL scraping, YouTube transcription) | ✓ Complete |
| Google Calendar integration (OAuth, CRUD) | ✓ Complete |
| Human escalation with assistant mode | ✓ Complete |
| Bidirectional media support (multimodal LLM) | ✓ Complete |
| Admin portal (Next.js 16, shadcn/ui, DM Sans) | ✓ Complete |
| Agent Designer + Wizard + 6 pre-built templates | ✓ Complete |
| Stripe billing (per-agent monthly, 14-day trial) | ✓ Complete |
| BYO API keys (Fernet encrypted) | ✓ Complete |
| Cost dashboard with Recharts | ✓ Complete |
| 3-tier RBAC (platform admin, customer admin, operator) | ✓ Complete |
| Email invitation flow (SMTP, HMAC tokens) | ✓ Complete |
| Web Chat with real-time streaming (bypass Celery) | ✓ Complete |
| Multilanguage (English, Spanish, Portuguese) | ✓ Complete |
| Mobile layout (bottom tab bar, full-screen chat) | ✓ Complete |
| PWA (service worker, push notifications, offline queue) | ✓ Complete |
| E2E tests (Playwright, 7 flows, 3 browsers) | ✓ Complete |
| CI pipeline (Gitea Actions) | ✓ Complete |
| Premium UI (indigo brand, dark sidebar, glass-morphism) | ✓ Complete |
### v2 Scope (Deferred)
- Multi-agent teams and coordinator pattern
- Microsoft Teams, Mattermost, Telegram channels
- Self-hosted deployment (Helm chart)
- Schema-per-tenant isolation
- Agent marketplace
- Voice/telephony channels
- SSO/SAML for enterprise
- Granular operator permissions
## Context
- **Market gap:** Existing AI tools are dashboards or chatbots, not channel-native workers. No coordinated AI teams. No self-hosted options for enterprises.
- **Target customer:** SMBs that need additional staff capacity but lack resources, are overwhelmed with processes, or want to grow faster.
- **Tech foundation:** Python 3.12+ (FastAPI, SQLAlchemy 2.0, Celery), Next.js 16 (App Router, shadcn/ui, next-intl, Serwist), PostgreSQL 16 + pgvector, Redis, Ollama, Docker Compose.
## Key Decisions
| Decision | Rationale | Outcome |
|----------|-----------|---------|
| Slack + WhatsApp + Web Chat channels | Covers office (Slack), customers (WhatsApp), and portal users (Web Chat) | ✓ Shipped |
| Single agent per tenant for v1 | Prove channel-native thesis before team complexity | ✓ Shipped |
| Full portal from day one | Beta users need UI, not config files | ✓ Shipped |
| Local + commercial LLMs | Ollama for dev/cost, commercial for quality | ✓ Shipped |
| PostgreSQL RLS multi-tenancy | Simplest, sufficient for Starter tier | ✓ Shipped |
| Web chat bypasses Celery | Direct LLM streaming from WebSocket for speed | ✓ Shipped |
| Per-agent monthly pricing | Matches "hire an employee" metaphor | ✓ Shipped |
| 3-tier RBAC with invite flow | Self-service for customers, control for operators | ✓ Shipped |
| DM Sans + indigo brand | Premium SaaS aesthetic for SMB market | ✓ Shipped |
---
*Last updated: 2026-03-26 after Phase 10 completion*