How weseek/growi works
Project type and purpose
• GROWI is a full‑stack, monorepo web application (Turbor repo) for collaborative knowledge management.
• It comprises three “apps” (app, pdf‑converter, slackbot‑proxy) plus shared “packages” (core, ui, editor, etc.).
• The main “app” is a Next.js application (React client + Node.js/Express‑style API + WebSocket) backed by MongoDB, optional Redis (session/pub‑sub), Elasticsearch, and file‑storage services.
High‑level decomposition
A. Client Layer
• Browser/React (Next.js) – SSR & CSR code under apps/app/src/client & pages.
• Third‑party UIs (mobile, API clients).
B. Edge/API Layer
• Next.js server (apps/app/src/server/app.ts) exposing
– SSR routes (Next pages)
– RESTful APIV3 endpoints (Express routers under server/routes/apiv3)
– File download/upload endpoints
– WebSocket (socket.io) for real‑time collaboration (apps/app/src/server/service/socket‑io).
C. Microservice Layer
• PDF Converter (apps/pdf‑converter/src) – HTTP microservice invoked by page‑bulk‑export jobs to generate PDFs.
• Slackbot Proxy (apps/slackbot‑proxy/src) – Nest/Express‑style microservice handling Slack slash commands/events.
D. Data & Infrastructure Layer
• MongoDB (primary persistence)
• Elasticsearch (full‑text search via search‑delegator)
• Redis (optional: session store, pub/sub for Yjs & events)
• Object Storage (S3/GCS/Azure) via file‑uploader module
• Shared packages & components (packages/*)
Main components & interactions
• Client → Next.js (HTTP GET/POST for pages, API calls via apiv3 clients under src/util).
• Next.js ←→ MongoDB (via Mongoose models under src/server/models).
• Next.js ←→ Elasticsearch (via search‑delegator module).
• Next.js ←→ Redis (session, optionally pub/sub for Yjs CRDT sync).
• Next.js WebSocket server → Clients for live editing (Yjs + socket.io).
• Next.js Cron/Job scheduler (page‑bulk‑export server‑side modules) → HTTP → PDF Converter → Storage.
• Next.js → Slackbot‑Proxy (HTTP webhook calls for events) → Slack API.
• Slackbot‑Proxy → Growi API (app’s APIV3) to create/search pages or handle commands.
• Optional integrations: LDAP/OAuth/SAML auth via APIV3 routes.
• Shared packages (core, ui, editor) imported by the apps.
Architectural patterns & technologies
• Monorepo (pnpm + Turborepo) with multiple apps + shared libs.
• Frontend/Backend separation: Next.js SSR + REST API under same runtime.
• Microservices: PDF and Slack proxy as separate processes/containers.
• Event‑driven: internal event emitters (comments, bookmark, page) and Redis/Nchan for pub‑sub.
• CRDT real‑time editing: Yjs persistence in MongoDB + socket.io.
• Plugin system: APIV3 plugin routes & Growi‑Plugin package.
• CI/CD: GitHub Actions workflows for each app.
Key details to capture
• The monorepo structure & shared packages overhead.
• Next.js dual role: SSR pages + JSON API.
• Real‑time collaboration stack: WebSocket ↔ Yjs ↔ MongoDB.
• Asynchronous workflow: Bulk export → PDF Converter → Cloud storage.
• Slack integration: Slackbot‑Proxy service ↔ Growi APIV3 ↔ Slack API.
• External auth flows (LDAP/OAuth/SAML) plugged into APIV3 middleware.