Developer Guide
For contributors, self-hosters extending DocuGardener, and teams building integrations.
DocuGardener is an open-source project licensed under AGPL-3.0. This guide is for developers who want to understand the internal architecture, contribute code, build integrations, or customise a self-hosted deployment beyond the standard configuration.
Tech Stack
| Layer | Technology |
|---|---|
| Frontend / Control Plane | Next.js 14 (App Router), React 18, Tailwind CSS, Prisma ORM |
| Authentication | NextAuth (GitHub OAuth, email magic link, SAML SSO) |
| Backend / Analysis Plane | Python 3.13, FastAPI, RQ (Redis Queue) workers |
| Databases | PostgreSQL (shared), Redis (queues), Weaviate (vector embeddings) |
| LLM Providers | Google Gemini, OpenAI, Anthropic, Ollama (BYOK) |
| Monitoring | Grafana dashboards, structured logging |
Sections
Architecture
Two-plane architecture, data flow from webhook to check run, queue design, and vector database usage.
API Reference
REST API endpoints exposed by the FastAPI analysis plane and the Next.js control plane.
Webhooks
GitHub webhook events DocuGardener listens to, payload handling, and security verification.
Contributing
How to set up a development environment, run tests, and submit pull requests.
Running Tests
Python pytest suite, Vitest frontend tests, and Playwright end-to-end tests.
Design System
Token reference, StatusChip, DataTable, PageHeader primitives, and UI contribution rules.
Quick Links
- Repository: github.com/docugardener/docugardener
- License: AGPL-3.0
- Issues: GitHub Issues
- Discussions: GitHub Discussions