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>
This commit is contained in:
@@ -2,69 +2,74 @@
|
||||
|
||||
## What This Is
|
||||
|
||||
Konstruct is an AI workforce platform where SMBs subscribe to AI employees that communicate through familiar messaging channels — Slack and WhatsApp for v1. Clients get an AI worker that shows up where their team already communicates, requiring zero behavior change. Think "hire an AI department" rather than "subscribe to another SaaS dashboard."
|
||||
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 or WhatsApp.
|
||||
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.
|
||||
|
||||
## Requirements
|
||||
## Current State (v1.0 — Beta-Ready)
|
||||
|
||||
### Validated
|
||||
All 10 phases complete. 39 plans executed. 67 requirements satisfied.
|
||||
|
||||
(None yet — ship to validate)
|
||||
### What's Shipped
|
||||
|
||||
### Active
|
||||
| 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 |
|
||||
|
||||
- [ ] Channel Gateway that normalizes messages from Slack and WhatsApp into a unified internal format
|
||||
- [ ] Single AI employee per tenant with configurable role, persona, and tools
|
||||
- [ ] Multi-tenant architecture with proper isolation (PostgreSQL RLS for Starter tier)
|
||||
- [ ] LLM backend pool with Ollama (local) + commercial APIs (Anthropic/OpenAI) via LiteLLM
|
||||
- [ ] Full admin portal (Next.js) for tenant management, agent configuration, and monitoring
|
||||
- [ ] Tenant onboarding flow in the portal
|
||||
- [ ] Billing integration (Stripe) for subscription management
|
||||
- [ ] Conversational memory (conversation history + vector search)
|
||||
- [ ] Tool framework for agent capabilities (registry, execution)
|
||||
- [ ] Rate limiting per tenant and per channel
|
||||
### v2 Scope (Deferred)
|
||||
|
||||
### Out of Scope
|
||||
|
||||
- Multi-agent teams and coordinator pattern — v2 (need single agent working first)
|
||||
- AI company hierarchy (teams of teams) — v2+
|
||||
- Microsoft Teams, Mattermost, Rocket.Chat, Signal, Telegram — v2 channel expansion
|
||||
- BYO API key support — moved to v1 Phase 3 (operator requested during scoping)
|
||||
- Self-hosted deployment (Helm chart) — v2+ (SaaS-first for beta)
|
||||
- Voice/telephony channels — v3+
|
||||
- Agent marketplace / pre-built templates — v3+
|
||||
- SOC 2 / HIPAA compliance — post-revenue
|
||||
- White-labeling for agencies — future consideration
|
||||
- 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. Konstruct addresses all three.
|
||||
- **Target customer:** SMBs that need additional staff capacity but lack resources, are overwhelmed with processes, or want to grow faster but can't find the right balance.
|
||||
- **Inspiration:** paperclip.ing — but differentiated by channel-native presence, tiered multi-tenancy, and eventual BYO-model support.
|
||||
- **V1 goal:** Beta-ready product that can accept early users. One AI employee per tenant on Slack + WhatsApp, managed through a full admin portal, with multi-tenancy and billing.
|
||||
- **Tech foundation:** Python (FastAPI) backend, Next.js portal, PostgreSQL + Redis, Docker Compose for dev, monorepo structure.
|
||||
|
||||
## Constraints
|
||||
|
||||
- **Tech stack:** Python 3.12+ (FastAPI, SQLAlchemy 2.0, Pydantic v2), Next.js 14+ (App Router, shadcn/ui), PostgreSQL 16, Redis — as specified in CLAUDE.md
|
||||
- **V1 channels:** Slack (slack-bolt) + WhatsApp (Business Cloud API) only
|
||||
- **LLM providers:** Ollama (local) + Anthropic/OpenAI (commercial) via LiteLLM — no BYO in v1
|
||||
- **Multi-tenancy:** PostgreSQL RLS for v1 (Starter tier), schema isolation deferred to v2
|
||||
- **Deployment:** Docker Compose for dev, single-server deployment for beta — Kubernetes deferred
|
||||
- **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 for v1 channels | Slack = where SMB teams work, WhatsApp = massive business communication reach | — Pending |
|
||||
| Single agent per tenant for v1 | Prove the channel-native thesis before adding team complexity | — Pending |
|
||||
| Full portal from day one | Beta users need a proper UI, not config files — lowers barrier to adoption | — Pending |
|
||||
| Local + commercial LLMs | Ollama for dev/cheap tasks, commercial APIs for quality — balances cost and capability | — Pending |
|
||||
| PostgreSQL RLS multi-tenancy | Simplest to start, sufficient for Starter tier, upgrade path to schema isolation exists | — Pending |
|
||||
| Beta-ready as v1 target | Multi-tenancy + billing = can accept real users, not just demos | — Pending |
|
||||
| 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-22 after initialization*
|
||||
*Last updated: 2026-03-26 after Phase 10 completion*
|
||||
|
||||
Reference in New Issue
Block a user