# unboxed/bops architecture

> Architecture diagram of the GitHub repository unboxed/bops, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/unboxed/bops
- Repository: https://github.com/unboxed/bops

## Overview

BOPS is a multi-tenant back-office planning system, with applicant-facing submission and validation APIs alongside staff workflows for consultation, assessment, review and determination. Supporting engines provide administration, configuration, consultee, enforcement, pre-application, reporting and upload capabilities. The README confirms API-based application submission and subdomain-based authority selection. Most source excerpts do not expose routing or cross-component calls, so the graph keeps uncertain workflow links dashed rather than asserting an implementation pipeline.

Main entry points: [`app/controllers/planning_applications_controller.rb`](https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications_controller.rb) (Planning applications), [`app/controllers/planning_applications/consultations_controller.rb`](https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/consultations_controller.rb) (Consultation), [`engines/bops_submissions/app`](https://github.com/unboxed/bops/tree/main/engines/bops_submissions/app) (Submission API), [`app/controllers/planning_applications/review`](https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/review) (Review and decision)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_submission["Submission and validation"]
  node_submission_api["Submission API"]
  node_applicant_portal["Applicant portal"]
  node_validation["Application validation"]
  node_api["Planning API"]
end

subgraph group_casework["Planning casework"]
  node_planning_cases["Planning applications"]
  node_consultation["Consultation"]
  node_consultees["Consultee workflows"]
  node_neighbours["Neighbour responses"]
  node_publicity["Publicity notices"]
  node_enforcement["Enforcement"]
  node_preapps["Pre-applications"]
end

subgraph group_assessment["Assessment and review"]
  node_assessment["Assessment"]
  node_review["Review and decision"]
  node_reports["Reports"]
end

subgraph group_engines["Product engines"]
  node_admin["Administration"]
  node_configuration["Authority configuration"]
  node_uploads["File uploads"]
end

subgraph group_platform["Shared services"]
  node_records[("Planning records")]
  node_constraint_query["Constraint lookup"]
  node_planx["Planning data service"]
end

node_applicant(("Applicant"))
node_staff(("Planning staff"))

node_applicant -.->|"submits applications"| node_submission_api
node_applicant -.->|"uses"| node_applicant_portal
node_submission_api -.->|"creates cases"| node_planning_cases
node_api -.->|"serves application data"| node_planning_cases
node_staff -.->|"validates cases"| node_validation
node_staff -.->|"manages consultation"| node_consultation
node_consultation -.->|"coordinates"| node_consultees
node_consultation -.->|"collects responses"| node_neighbours
node_staff -.->|"manages notices"| node_publicity
node_staff -.->|"assesses cases"| node_assessment
node_staff -.->|"reviews decisions"| node_review
node_review -.->|"supports reporting"| node_reports
node_staff -.->|"handles enforcement"| node_enforcement
node_applicant -.->|"requests pre-app advice"| node_preapps
node_staff -.->|"administers system"| node_admin
node_admin -.->|"configures authorities"| node_configuration
node_staff -.->|"uploads files"| node_uploads
node_planning_cases -.->|"persists cases"| node_records
node_constraint_query -->|"queries constraints"| node_planx
node_planning_cases -.->|"updates constraints"| node_constraint_query

click node_submission_api "https://github.com/unboxed/bops/tree/main/engines/bops_submissions/app"
click node_applicant_portal "https://github.com/unboxed/bops/tree/main/engines/bops_applicants/app"
click node_validation "https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/validation"
click node_api "https://github.com/unboxed/bops/tree/main/app/controllers/api/v1"
click node_planning_cases "https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications_controller.rb"
click node_consultation "https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/consultations_controller.rb"
click node_consultees "https://github.com/unboxed/bops/tree/main/engines/bops_consultees/app"
click node_neighbours "https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/neighbour_responses_controller.rb"
click node_publicity "https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/site_notices_controller.rb"
click node_assessment "https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/assessment"
click node_review "https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/review"
click node_reports "https://github.com/unboxed/bops/tree/main/engines/bops_reports/app"
click node_enforcement "https://github.com/unboxed/bops/tree/main/engines/bops_enforcements/app"
click node_preapps "https://github.com/unboxed/bops/tree/main/engines/bops_preapps/app"
click node_admin "https://github.com/unboxed/bops/tree/main/engines/bops_admin/app"
click node_configuration "https://github.com/unboxed/bops/tree/main/engines/bops_config/app"
click node_uploads "https://github.com/unboxed/bops/tree/main/engines/bops_uploads/app"
click node_records "https://github.com/unboxed/bops/tree/main/app/models"
click node_constraint_query "https://github.com/unboxed/bops/blob/main/app/services/constraint_query_update_service.rb"

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_submission_api,node_applicant_portal,node_validation,node_api toneBlue
class node_planning_cases,node_consultation,node_consultees,node_neighbours,node_publicity,node_enforcement,node_preapps toneAmber
class node_assessment,node_review,node_reports toneMint
class node_admin,node_configuration,node_uploads toneRose
class node_records,node_constraint_query,node_planx,node_applicant,node_staff toneIndigo
```

## Components

### Submission and validation

- [Submission API](https://github.com/unboxed/bops/tree/main/engines/bops_submissions/app): `engines/bops_submissions/app`
- [Applicant portal](https://github.com/unboxed/bops/tree/main/engines/bops_applicants/app): `engines/bops_applicants/app`
- [Application validation](https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/validation): `app/controllers/planning_applications/validation`
- [Planning API](https://github.com/unboxed/bops/tree/main/app/controllers/api/v1): `app/controllers/api/v1`

### Planning casework

- [Planning applications](https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications_controller.rb): `app/controllers/planning_applications_controller.rb`
- [Consultation](https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/consultations_controller.rb): `app/controllers/planning_applications/consultations_controller.rb`
- [Consultee workflows](https://github.com/unboxed/bops/tree/main/engines/bops_consultees/app): `engines/bops_consultees/app`
- [Neighbour responses](https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/neighbour_responses_controller.rb): `app/controllers/planning_applications/neighbour_responses_controller.rb`
- [Publicity notices](https://github.com/unboxed/bops/blob/main/app/controllers/planning_applications/site_notices_controller.rb): `app/controllers/planning_applications/site_notices_controller.rb`
- [Enforcement](https://github.com/unboxed/bops/tree/main/engines/bops_enforcements/app): `engines/bops_enforcements/app`
- [Pre-applications](https://github.com/unboxed/bops/tree/main/engines/bops_preapps/app): `engines/bops_preapps/app`

### Assessment and review

- [Assessment](https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/assessment): `app/controllers/planning_applications/assessment`
- [Review and decision](https://github.com/unboxed/bops/tree/main/app/controllers/planning_applications/review): `app/controllers/planning_applications/review`
- [Reports](https://github.com/unboxed/bops/tree/main/engines/bops_reports/app): `engines/bops_reports/app`

### Product engines

- [Administration](https://github.com/unboxed/bops/tree/main/engines/bops_admin/app): `engines/bops_admin/app`
- [Authority configuration](https://github.com/unboxed/bops/tree/main/engines/bops_config/app): `engines/bops_config/app`
- [File uploads](https://github.com/unboxed/bops/tree/main/engines/bops_uploads/app): `engines/bops_uploads/app`

### Shared services

- [Planning records](https://github.com/unboxed/bops/tree/main/app/models): `app/models`
- [Constraint lookup](https://github.com/unboxed/bops/blob/main/app/services/constraint_query_update_service.rb): `app/services/constraint_query_update_service.rb`
- **Planning data service**

### Other components

- **Applicant**
- **Planning staff**

## Connections

- Applicant → Submission API: submits applications
- Applicant → Applicant portal: uses
- Submission API → Planning applications: creates cases
- Planning API → Planning applications: serves application data
- Planning staff → Application validation: validates cases
- Planning staff → Consultation: manages consultation
- Consultation → Consultee workflows: coordinates
- Consultation → Neighbour responses: collects responses
- Planning staff → Publicity notices: manages notices
- Planning staff → Assessment: assesses cases
- Planning staff → Review and decision: reviews decisions
- Review and decision → Reports: supports reporting
- Planning staff → Enforcement: handles enforcement
- Applicant → Pre-applications: requests pre-app advice
- Planning staff → Administration: administers system
- Administration → Authority configuration: configures authorities
- Planning staff → File uploads: uploads files
- Planning applications → Planning records: persists cases
- Constraint lookup → Planning data service: queries constraints (evidence: `app/services/constraint_query_update_service.rb`)
- Planning applications → Constraint lookup: updates constraints
