From 1b2cf02e1aadb5a20dbe7f6b2e6846de0029a713 Mon Sep 17 00:00:00 2001 From: parthib2006 Date: Tue, 27 Jan 2026 19:08:37 +0530 Subject: [PATCH] Fix README Project Architecture --- README.md | 71 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 36 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 3fde6af..b7712bf 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,7 @@ npm install -g coderrr-cli cd C:\Coder\Coderrr coderrr ### Quick Start (Zero Config!) +``` ```bash npm install -g coderrr-cli @@ -255,44 +256,44 @@ The Coderrr repository follows a clean and modular structure to improve maintainability, scalability, and contributor onboarding. ```text -Coderrr/ -├── bin/ # CLI entry points (modern CLI & legacy TUI) -├── src/ # Core agent logic, file operations, execution & UI -├── backend/ # FastAPI backend for AI processing -├── docs/ # Detailed documentation (architecture, API, guides) -├── examples/ # Example usage and demo projects -├── test/ # General test files -├── tests/unit/ # Unit tests for core components -├── .github/ # GitHub Actions, CI/CD workflows, templates -├── package.json # Node.js dependencies and CLI metadata -├── README.md # Project overview and usage guide -└── LICENSE # MIT license - +📁 Coderrr/ +├── 📁 bin/ # CLI entry points (modern CLI & legacy TUI) +├── 📁 src/ # Core agent logic, file operations, execution & UI +├── 📁 backend/ # FastAPI backend for AI processing +├── 📁 docs/ # Detailed documentation (architecture, API, guides) +├── 📁 examples/ # Example usage and demo projects +├── 📁 test/ # General test files +├── 📁 tests/unit/ # Unit tests for core components +├── 📁 .github/ # GitHub Actions, CI/CD workflows, templates +├── 📄 package.json # Node.js dependencies and CLI metadata +├── 📄 README.md # Project overview and usage guide +└── 📄 LICENSE # MIT license +``` --- ## Architecture -``` -Coderrr/ -├── bin/ -│ ├── coderrr.js # Modern CLI (commander-based) -│ └── coderrr-cli.js # Legacy TUI (blessed-based) -├── src/ -│ ├── agent.js # Core agent logic & orchestration -│ ├── fileOps.js # File operations handler -│ ├── executor.js # Command executor with permissions -│ ├── todoManager.js # TODO tracking & visualization -│ ├── codebaseScanner.js # Project structure scanner -│ └── ui.js # UI utilities & components -├── backend/ -│ ├── main.py # FastAPI backend server -│ └── requirements.txt # Python dependencies -├── test/ # Test suite -├── docs/ # Documentation -├── examples/ # Usage examples -├── .github/ # CI/CD workflows -├── package.json -└── .env # Environment configuration +```bash +📁 Coderrr/ +├── 📁 bin/ +│ ├── 📄 coderrr.js # Modern CLI (commander-based) +│ └── 📄 coderrr-cli.js # Legacy TUI (blessed-based) +├── 📁 src/ +│ ├── 📄 agent.js # Core agent logic & orchestration +│ ├── 📄 fileOps.js # File operations handler +│ ├── 📄 executor.js # Command executor with permissions +│ ├── 📄 todoManager.js # TODO tracking & visualization +│ ├── 📄 codebaseScanner.js # Project structure scanner +│ └── 📄 ui.js # UI utilities & components +├── 📁 backend/ +│ ├── 📄 main.py # FastAPI backend server +│ └── 📄 requirements.txt # Python dependencies +├── 📁 test/ # Test suite +├── 📁 docs/ # Documentation +├── 📁 examples/ # Usage examples +├── 📁 .github/ # CI/CD workflows +├── 📄 package.json +└── 📄 .env # Environment configuration ``` ### Backend (FastAPI) @@ -463,4 +464,4 @@ Inspired by: --- -**Built by developers, for developers** +**Built by developers, for developers** \ No newline at end of file