# rami6782/plan-generate architecture

> Architecture diagram of the GitHub repository rami6782/plan-generate, 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/rami6782/plan-generate
- Repository: https://github.com/rami6782/plan-generate

## Overview

This is a React project-plan generator. A user enters project basics, chooses scope, configures resources and commercial assumptions, then reviews a cost breakdown and triggers a success notification. Reference data comes through React Query hooks and an API layer that uses local mock values by default, with REST fetching available when configured. The graph follows the wizard and data-fetch path; unsampled step implementations are represented by their exact component paths, but their internal behavior and additional connections are not inferred.

Main entry points: [`src/components/PlanWizard.tsx`](https://github.com/rami6782/plan-generate/blob/main/src/components/PlanWizard.tsx) (Plan wizard), [`src/hooks/use-api-data.ts`](https://github.com/rami6782/plan-generate/blob/main/src/hooks/use-api-data.ts) (Reference data hooks), [`src/components/StepBasics.tsx`](https://github.com/rami6782/plan-generate/blob/main/src/components/StepBasics.tsx) (Project basics), [`src/components/StepReview.tsx`](https://github.com/rami6782/plan-generate/blob/main/src/components/StepReview.tsx) (Plan review)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Plan workflow"]
  node_wizard["Plan wizard<br/>[PlanWizard.tsx]"]
  node_basics["Project basics<br/>[StepBasics.tsx]"]
  node_scope["Scope selection<br/>[StepScope.tsx]"]
  node_resources["Resource mix<br/>[StepResources.tsx]"]
  node_commercial["Commercial inputs<br/>[StepCommercial.tsx]"]
  node_review["Plan review<br/>[StepReview.tsx]"]
  node_costs["Cost breakdown"]
  node_steps["Step indicator<br/>[StepIndicator.tsx]"]
end

subgraph group_data["Reference data"]
  node_hooks["Reference data hooks<br/>[use-api-data.ts]"]
  node_api["API service<br/>[api.ts]"]
  node_mock["Mock reference data<br/>[mock-data.ts]"]
end

subgraph group_runtime["App runtime"]
  node_entry["App routing<br/>[App.tsx]"]
  node_home["Plan page<br/>[Index.tsx]"]
  node_notfound["Not-found page<br/>[NotFound.tsx]"]
end

subgraph group_shared["UI primitives"]
  node_button["Button primitive<br/>[button.tsx]"]
  node_input["Input primitive<br/>[input.tsx]"]
end

node_user(("Plan author"))
node_rest["Configured REST API"]

node_user -->|"opens app"| node_entry
node_entry -->|"routes /"| node_home
node_entry -->|"routes fallback"| node_notfound
node_home -->|"renders"| node_wizard
node_wizard -->|"renders"| node_steps
node_wizard -->|"renders step"| node_basics
node_wizard -->|"renders step"| node_scope
node_wizard -->|"renders step"| node_resources
node_wizard -->|"renders step"| node_commercial
node_wizard -->|"renders step"| node_review
node_wizard -->|"uses controls"| node_button
node_wizard -->|"initializes defaults"| node_mock
node_basics -->|"loads countries"| node_hooks
node_basics -->|"uses input"| node_input
node_scope -->|"loads reference data"| node_hooks
node_resources -->|"loads reference data"| node_hooks
node_review -->|"loads review data"| node_hooks
node_review -->|"renders breakdown"| node_costs
node_costs -->|"reads reference data"| node_mock
node_wizard -->|"shows success"| node_user
node_hooks -->|"queries data"| node_api
node_api -->|"uses fallback data"| node_mock
node_api -.->|"fetches when configured"| node_rest

click node_entry "https://github.com/rami6782/plan-generate/blob/main/src/App.tsx"
click node_home "https://github.com/rami6782/plan-generate/blob/main/src/pages/Index.tsx"
click node_wizard "https://github.com/rami6782/plan-generate/blob/main/src/components/PlanWizard.tsx"
click node_basics "https://github.com/rami6782/plan-generate/blob/main/src/components/StepBasics.tsx"
click node_scope "https://github.com/rami6782/plan-generate/blob/main/src/components/StepScope.tsx"
click node_resources "https://github.com/rami6782/plan-generate/blob/main/src/components/StepResources.tsx"
click node_commercial "https://github.com/rami6782/plan-generate/blob/main/src/components/StepCommercial.tsx"
click node_review "https://github.com/rami6782/plan-generate/blob/main/src/components/StepReview.tsx"
click node_costs "https://github.com/rami6782/plan-generate/blob/main/src/components/CostBreakdownTable.tsx"
click node_steps "https://github.com/rami6782/plan-generate/blob/main/src/components/StepIndicator.tsx"
click node_hooks "https://github.com/rami6782/plan-generate/blob/main/src/hooks/use-api-data.ts"
click node_api "https://github.com/rami6782/plan-generate/blob/main/src/lib/api.ts"
click node_mock "https://github.com/rami6782/plan-generate/blob/main/src/lib/mock-data.ts"
click node_notfound "https://github.com/rami6782/plan-generate/blob/main/src/pages/NotFound.tsx"
click node_button "https://github.com/rami6782/plan-generate/blob/main/src/components/ui/button.tsx"
click node_input "https://github.com/rami6782/plan-generate/blob/main/src/components/ui/input.tsx"

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_wizard,node_basics,node_scope,node_resources,node_commercial,node_review,node_costs,node_steps toneBlue
class node_hooks,node_api,node_mock toneAmber
class node_entry,node_home,node_notfound,node_rest toneMint
class node_button,node_input toneRose
class node_user toneIndigo
```

## Components

### Plan workflow

- [Plan wizard](https://github.com/rami6782/plan-generate/blob/main/src/components/PlanWizard.tsx): `src/components/PlanWizard.tsx`
- [Project basics](https://github.com/rami6782/plan-generate/blob/main/src/components/StepBasics.tsx): `src/components/StepBasics.tsx`
- [Scope selection](https://github.com/rami6782/plan-generate/blob/main/src/components/StepScope.tsx): `src/components/StepScope.tsx`
- [Resource mix](https://github.com/rami6782/plan-generate/blob/main/src/components/StepResources.tsx): `src/components/StepResources.tsx`
- [Commercial inputs](https://github.com/rami6782/plan-generate/blob/main/src/components/StepCommercial.tsx): `src/components/StepCommercial.tsx`
- [Plan review](https://github.com/rami6782/plan-generate/blob/main/src/components/StepReview.tsx): `src/components/StepReview.tsx`
- [Cost breakdown](https://github.com/rami6782/plan-generate/blob/main/src/components/CostBreakdownTable.tsx): `src/components/CostBreakdownTable.tsx`
- [Step indicator](https://github.com/rami6782/plan-generate/blob/main/src/components/StepIndicator.tsx): `src/components/StepIndicator.tsx`

### Reference data

- [Reference data hooks](https://github.com/rami6782/plan-generate/blob/main/src/hooks/use-api-data.ts): `src/hooks/use-api-data.ts`
- [API service](https://github.com/rami6782/plan-generate/blob/main/src/lib/api.ts): `src/lib/api.ts`
- [Mock reference data](https://github.com/rami6782/plan-generate/blob/main/src/lib/mock-data.ts): `src/lib/mock-data.ts`

### App runtime

- [App routing](https://github.com/rami6782/plan-generate/blob/main/src/App.tsx): `src/App.tsx`
- [Plan page](https://github.com/rami6782/plan-generate/blob/main/src/pages/Index.tsx): `src/pages/Index.tsx`
- [Not-found page](https://github.com/rami6782/plan-generate/blob/main/src/pages/NotFound.tsx): `src/pages/NotFound.tsx`

### UI primitives

- [Button primitive](https://github.com/rami6782/plan-generate/blob/main/src/components/ui/button.tsx): `src/components/ui/button.tsx`
- [Input primitive](https://github.com/rami6782/plan-generate/blob/main/src/components/ui/input.tsx): `src/components/ui/input.tsx`

### Other components

- **Plan author**
- **Configured REST API**

## Connections

- Plan author → App routing: opens app (evidence: `src/App.tsx`)
- App routing → Plan page: routes / (evidence: `src/App.tsx`)
- App routing → Not-found page: routes fallback (evidence: `src/App.tsx`)
- Plan page → Plan wizard: renders (evidence: `src/pages/Index.tsx`)
- Plan wizard → Step indicator: renders (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Project basics: renders step (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Scope selection: renders step (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Resource mix: renders step (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Commercial inputs: renders step (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Plan review: renders step (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Button primitive: uses controls (evidence: `src/components/PlanWizard.tsx`)
- Plan wizard → Mock reference data: initializes defaults (evidence: `src/components/PlanWizard.tsx`)
- Project basics → Reference data hooks: loads countries (evidence: `src/components/StepBasics.tsx`)
- Project basics → Input primitive: uses input (evidence: `src/components/StepBasics.tsx`)
- Scope selection → Reference data hooks: loads reference data (evidence: `src/components/StepScope.tsx`)
- Resource mix → Reference data hooks: loads reference data (evidence: `src/components/StepResources.tsx`)
- Plan review → Reference data hooks: loads review data (evidence: `src/components/StepReview.tsx`)
- Plan review → Cost breakdown: renders breakdown (evidence: `src/components/StepReview.tsx`)
- Cost breakdown → Mock reference data: reads reference data (evidence: `src/components/CostBreakdownTable.tsx`)
- Plan wizard → Plan author: shows success (evidence: `src/components/PlanWizard.tsx`)
- Reference data hooks → API service: queries data (evidence: `src/hooks/use-api-data.ts`)
- API service → Mock reference data: uses fallback data (evidence: `src/lib/api.ts`)
- API service → Configured REST API: fetches when configured (evidence: `src/lib/api.ts`)
