How n4ze3m/dialoqbase works
Project Type and Purpose
• This is a full-stack, open-source chatbot platform (Dialoqbase) delivered as a monorepo.
• It includes:
• A Fastify-based Node.js backend (“server/”).
• A React/Vite-powered admin UI (“app/ui/”).
• A standalone embeddable chat widget (“app/widget/”).
• A script bundle for web-embed (“app/script/”).
• The system leverages PostgreSQL (vector search), Redis (caching/queues), a job queue (Bull), and pluggable AI providers (OpenAI, Anthropic, etc.).
Directory Structure Indicators
• Top-level “server/”: Fastify app, Prisma ORM, Cron jobs, queue controllers, integration handlers, embedding utilities.
• “app/ui/”: React + Ant Design admin console, page/routes, API services, state management.
• “app/widget/”: React widget, hooks, utils, communicates with backend via REST/SSE.
• “app/script/”: Rspack config to produce a single “<script>” embed for external sites.
• “docker/”: Compose file spinning up server, Postgres, Redis, SearxNG.
• “docs/”: VitePress documentation of features, guides, reference.
Key Architecture Patterns
• Monorepo + pnpm workspace for shared types & consistent versioning.
• Separation of concerns: Admin UI vs. Public widget vs. Backend API vs. Embedding script.
• API versioning under “/api/v1/…” routes and handlers.
• Event-driven processing: job queue (Bull) for document loaders & media controllers.
• Plugin architecture: Fastify plugins for JWT, Prisma, integration adapters.
• SSE for real-time chat stream (via @waylaidwanderer/fastify-sse-v2).
Main Components
A. Frontend “Admin UI” (app/ui)
• React SPA served by the backend or a static host.
• Routes → API calls to server’s /api/v1 endpoints.
B. Embeddable Widget (app/widget & app/script)
• JavaScript bundle installed on external sites.
• Communicates with backend via REST + SSE.
C. Backend API (server/src/app.ts)
• Fastify HTTP server exposing REST/SSE endpoints under /api/v1.
• Handlers for bots, conversations, playground, admin, integrations.
D. Data Stores
• PostgreSQL (vector DB for embeddings + relational data).
• Redis (caching & Bull job queue).
E. Job Queue & Workers (server/src/queue)
• Controllers for parsing/loading docs, crawlers, media → enqueue jobs → process embeddings.
F. External Services & Integrations
• AI Providers (OpenAI, Anthropic, Fireworks, Google, etc.).
• Message & voice integrations (Telegram, Discord, WhatsApp).
• SearxNG search (optional via docker).
Relationships and Data Flows
• Admin UI ←(HTTPS/REST)→ Backend API → (Prisma) → PostgreSQL
• Widget Embed ←(HTTPS/REST+SSE)→ Backend API
• Backend → Redis (cache, locks, job queue)
• Job Workers ← Redis ← Cron / API triggers
• Job Workers → AI Providers (HTTP) → Embeddings & Chat responses
• Integration adapters listen for Telegram/Discord events → Backend handlers
• Docker Compose orchestrates Backend, Postgres, Redis, SearxNG
Architectural Design Principles
• Clear API boundaries (versioned routes under /api/v1).
• Modular Fastify plugins (jwt, prisma, integration).
• Shared type definitions for contract consistency (app/ui/@types vs. server/schema).
• Asynchronous processing for heavy tasks via Bull.
• Embeddability and extensibility (script packaging with Rspack).