# directus-labs/agency-os architecture

> Architecture diagram of the GitHub repository directus-labs/agency-os, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/directus-labs/agency-os
- Repository: https://github.com/directus-labs/agency-os

## Overview

AgencyOS combines a public agency website with an authenticated client portal and agency operations features, using Nuxt as the frontend and Directus as its backend. A visitor searches or browses CMS content; a client can access project, task, file, and billing features in the portal. The README documents broader CRM, proposals, invoicing, and website capabilities than the sampled source shows. Search and Stripe webhook relationships are supported by excerpts; broader feature links are documented in the README.

Main entry points: [`modules/directus/index.ts`](https://github.com/directus-labs/agency-os/blob/main/modules/directus/index.ts) (Directus Integration), [`layers/portal/pages/portal/projects/[id]/index.vue`](https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal/projects/%5Bid%5D/index.vue) (Project Workspace), [`pages/[...permalink].vue`](https://github.com/directus-labs/agency-os/blob/main/pages/%5B...permalink%5D.vue) (Pages and Blog), [`server/api/search.get.ts`](https://github.com/directus-labs/agency-os/blob/main/server/api/search.get.ts) (Search API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_website["Public Website"]
  node_public_pages["Pages and Blog<br/>[&#91;...permalink&#93;.vue]"]
  node_page_builder["Page Builder<br/>[PageBuilder.vue]"]
  node_public_help["Help Center<br/>[index.vue]"]
  node_public_search["Global Search<br/>[GlobalSearch.vue]"]
  node_search_api["Search API<br/>[search.get.ts]"]
end

subgraph group_portal["Client Portal"]
  node_portal_pages["Portal Pages<br/>[portal.vue]"]
  node_portal_projects["Project Workspace<br/>[index.vue]"]
  node_portal_tasks["Task Management<br/>[TaskList.vue]"]
  node_portal_files["Client Files<br/>[FilesView.vue]"]
  node_portal_billing["Client Billing<br/>[index.vue]"]
  node_stripe_checkout["Stripe Checkout"]
  node_stripe_webhook["Stripe Webhook<br/>[webhooks.post.ts]"]
end

subgraph group_operations["Agency Operations"]
  node_proposals["Proposal Builder<br/>[&#91;id&#93;.vue]"]
  node_crm_models["CRM and Project Models"]
end

subgraph group_platform["Platform and Content"]
  node_directus_module["Directus Integration<br/>[index.ts]"]
  node_directus_auth["Directus Authentication<br/>[useDirectusAuth.ts]"]
  node_content_types["CMS and Block Types<br/>[schema.ts]"]
end

node_visitor(("Website Visitor"))
node_client(("Portal Client"))
node_directus[("Directus Backend")]
node_stripe["Stripe"]

node_visitor -->|"browses"| node_public_pages
node_public_pages -.->|"renders blocks"| node_page_builder
node_visitor -->|"browses"| node_public_help
node_public_search -->|"requests results"| node_search_api
node_search_api -->|"queries content"| node_directus
node_client -->|"accesses"| node_portal_pages
node_portal_pages -.->|"opens projects"| node_portal_projects
node_portal_projects -->|"views tasks"| node_portal_tasks
node_portal_projects -->|"views files"| node_portal_files
node_client -->|"views invoices"| node_portal_billing
node_portal_billing -->|"starts payment"| node_stripe_checkout
node_stripe -->|"sends events"| node_stripe_webhook
node_stripe_webhook -->|"records payment"| node_directus
node_proposals -.->|"builds proposals"| node_crm_models
node_directus_module -->|"connects SDK"| node_directus
node_directus_auth -->|"authenticates users"| node_directus
node_directus_module -->|"types schema"| node_content_types
node_directus_module -->|"loads globals and redirects"| node_directus

click node_public_pages "https://github.com/directus-labs/agency-os/blob/main/pages/%5B...permalink%5D.vue"
click node_page_builder "https://github.com/directus-labs/agency-os/blob/main/components/PageBuilder.vue"
click node_public_help "https://github.com/directus-labs/agency-os/blob/main/pages/help/index.vue"
click node_public_search "https://github.com/directus-labs/agency-os/blob/main/components/GlobalSearch.vue"
click node_search_api "https://github.com/directus-labs/agency-os/blob/main/server/api/search.get.ts"
click node_portal_pages "https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal.vue"
click node_portal_projects "https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal/projects/%5Bid%5D/index.vue"
click node_portal_tasks "https://github.com/directus-labs/agency-os/blob/main/layers/portal/components/TaskList.vue"
click node_portal_files "https://github.com/directus-labs/agency-os/blob/main/layers/portal/components/FilesView.vue"
click node_portal_billing "https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal/billing/index.vue"
click node_stripe_checkout "https://github.com/directus-labs/agency-os/blob/main/layers/portal/server/api/stripe/create-checkout-session.post.ts"
click node_stripe_webhook "https://github.com/directus-labs/agency-os/blob/main/layers/portal/server/api/stripe/webhooks.post.ts"
click node_proposals "https://github.com/directus-labs/agency-os/blob/main/layers/proposals/pages/proposals/%5Bid%5D.vue"
click node_crm_models "https://github.com/directus-labs/agency-os/tree/main/types/os"
click node_directus_module "https://github.com/directus-labs/agency-os/blob/main/modules/directus/index.ts"
click node_directus_auth "https://github.com/directus-labs/agency-os/blob/main/modules/directus/runtime/composables/useDirectusAuth.ts"
click node_content_types "https://github.com/directus-labs/agency-os/blob/main/types/schema.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_public_pages,node_page_builder,node_public_help,node_public_search,node_search_api,node_client toneBlue
class node_portal_pages,node_portal_projects,node_portal_tasks,node_portal_files,node_portal_billing,node_stripe_checkout,node_stripe_webhook,node_directus toneAmber
class node_proposals,node_crm_models toneMint
class node_directus_module,node_directus_auth,node_content_types toneRose
class node_visitor,node_stripe toneIndigo
```

## Components

### Public Website

- [Pages and Blog](https://github.com/directus-labs/agency-os/blob/main/pages/%5B...permalink%5D.vue): `pages/[...permalink].vue`
- [Page Builder](https://github.com/directus-labs/agency-os/blob/main/components/PageBuilder.vue): `components/PageBuilder.vue`
- [Help Center](https://github.com/directus-labs/agency-os/blob/main/pages/help/index.vue): `pages/help/index.vue`
- [Global Search](https://github.com/directus-labs/agency-os/blob/main/components/GlobalSearch.vue): `components/GlobalSearch.vue`
- [Search API](https://github.com/directus-labs/agency-os/blob/main/server/api/search.get.ts): `server/api/search.get.ts`

### Client Portal

- [Portal Pages](https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal.vue): `layers/portal/pages/portal.vue`
- [Project Workspace](https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal/projects/%5Bid%5D/index.vue): `layers/portal/pages/portal/projects/[id]/index.vue`
- [Task Management](https://github.com/directus-labs/agency-os/blob/main/layers/portal/components/TaskList.vue): `layers/portal/components/TaskList.vue`
- [Client Files](https://github.com/directus-labs/agency-os/blob/main/layers/portal/components/FilesView.vue): `layers/portal/components/FilesView.vue`
- [Client Billing](https://github.com/directus-labs/agency-os/blob/main/layers/portal/pages/portal/billing/index.vue): `layers/portal/pages/portal/billing/index.vue`
- [Stripe Checkout](https://github.com/directus-labs/agency-os/blob/main/layers/portal/server/api/stripe/create-checkout-session.post.ts): `layers/portal/server/api/stripe/create-checkout-session.post.ts`
- [Stripe Webhook](https://github.com/directus-labs/agency-os/blob/main/layers/portal/server/api/stripe/webhooks.post.ts): `layers/portal/server/api/stripe/webhooks.post.ts`

### Agency Operations

- [Proposal Builder](https://github.com/directus-labs/agency-os/blob/main/layers/proposals/pages/proposals/%5Bid%5D.vue): `layers/proposals/pages/proposals/[id].vue`
- [CRM and Project Models](https://github.com/directus-labs/agency-os/tree/main/types/os): `types/os`

### Platform and Content

- [Directus Integration](https://github.com/directus-labs/agency-os/blob/main/modules/directus/index.ts): `modules/directus/index.ts`
- [Directus Authentication](https://github.com/directus-labs/agency-os/blob/main/modules/directus/runtime/composables/useDirectusAuth.ts): `modules/directus/runtime/composables/useDirectusAuth.ts`
- [CMS and Block Types](https://github.com/directus-labs/agency-os/blob/main/types/schema.ts): `types/schema.ts`

### Other components

- **Website Visitor**
- **Portal Client**
- **Directus Backend**
- **Stripe**

## Connections

- Website Visitor → Pages and Blog: browses
- Pages and Blog → Page Builder: renders blocks
- Website Visitor → Help Center: browses
- Global Search → Search API: requests results (evidence: `components/GlobalSearch.vue`)
- Search API → Directus Backend: queries content (evidence: `server/api/search.get.ts`)
- Portal Client → Portal Pages: accesses
- Portal Pages → Project Workspace: opens projects
- Project Workspace → Task Management: views tasks
- Project Workspace → Client Files: views files
- Portal Client → Client Billing: views invoices
- Client Billing → Stripe Checkout: starts payment
- Stripe → Stripe Webhook: sends events (evidence: `layers/portal/server/api/stripe/webhooks.post.ts`)
- Stripe Webhook → Directus Backend: records payment (evidence: `layers/portal/server/api/stripe/webhooks.post.ts`)
- Proposal Builder → CRM and Project Models: builds proposals
- Directus Integration → Directus Backend: connects SDK (evidence: `modules/directus/index.ts`)
- Directus Authentication → Directus Backend: authenticates users (evidence: `modules/directus/runtime/composables/useDirectusAuth.ts`)
- Directus Integration → CMS and Block Types: types schema (evidence: `modules/directus/index.ts`)
- Directus Integration → Directus Backend: loads globals and redirects (evidence: `modules/directus/index.ts`)
