Skip to content

Commit a2b0a4c

Browse files
committed
docs(readme): refresh the project structure to match the current backend
1 parent 4b6f61b commit a2b0a4c

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -181,29 +181,38 @@ CodeABC supports two modes:
181181
CodeABC/
182182
├── backend/ # Python FastAPI server
183183
│ ├── app.py # Entry point, CORS, lifespan
184+
│ ├── desktop_server.py # Sidecar launcher for the Tauri desktop build
184185
│ ├── models.py # Pydantic data models
185186
│ ├── routers/
186187
│ │ ├── project.py # Upload / GitHub clone / file endpoints
187188
│ │ └── analyze.py # Overview + annotation generation
188189
│ ├── services/
189-
│ │ ├── scanner.py # Project file scanner with smart filtering
190-
│ │ ├── importgraph.py # Import-graph fan-in ranking (core-module detection)
191-
│ │ ├── github_clone.py # Shallow clone with size limits
192-
│ │ ├── llm.py # litellm wrapper (stream + non-stream)
193-
│ │ └── cache.py # SQLite cache layer
190+
│ │ ├── scanner.py # Project file scanner with smart filtering
191+
│ │ ├── importgraph.py # Import-graph fan-in ranking (core-module detection)
192+
│ │ ├── github_clone.py # Shallow clone with size limits
193+
│ │ ├── llm.py # litellm wrapper (stream + non-stream)
194+
│ │ ├── cache.py # SQLite cache + on-disk project library
195+
│ │ ├── codemap_export.py # Stitch every map into one offline codemap.md
196+
│ │ ├── report_export.py # Self-contained offline HTML report
197+
│ │ └── … # + 27 deterministic, no-API-key analyzers (one per map)
194198
│ └── prompts/
195199
│ ├── overview.py # Project overview prompt
196-
│ └── annotate.py # Line-by-line annotation prompt
200+
│ ├── annotate.py # Line-by-line annotation prompt
201+
│ ├── qa.py # Snippet / file Q&A prompt
202+
│ └── edit.py # Natural-language editing prompt
197203
├── frontend/ # React + Vite + TailwindCSS
198204
│ └── src/
199205
│ ├── pages/ # Home, Overview, FileView
200206
│ ├── components/ # UploadZone, CodeViewer, AnnotationTooltip, ApiKeyModal
201207
│ ├── stores/ # Zustand state management
202208
│ └── lib/ # API client
209+
├── scripts/ # Desktop sidecar build (PyInstaller)
203210
├── pyproject.toml
204211
└── README.md
205212
```
206213

214+
The `services/` analyzers are one module per deterministic map: `coverage`, `symbols`, `datamodels`, `settings_map`, `schedules`, `ci_checks`, `entrypoints`, `commands`, `envscan`, `dependencies`, `integrations`, `error_handling`, `techdebt`, `docs`, `complexity`, `churn`, `activity`, `ownership`, `licenses`, `security`, `risk`, `health_score`, `apimap`, `glossary`, `filenames`, `package_purposes`, and `action_plan`.
215+
207216
## Roadmap
208217

209218
### Shipped

0 commit comments

Comments
 (0)