-
-
Notifications
You must be signed in to change notification settings - Fork 29
Fix README Project Architecture #116
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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 | ||||||
|
||||||
| ```bash | |
| ```text |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a closing code block delimiter here creates a malformed markdown structure. Looking at the context, line 83 starts a bash code block, and line 87 contains a heading "### Quick Start (Zero Config!)" which should not be inside a code block. This closing delimiter would incorrectly end the code block started at line 83 before the heading, making the heading appear inside the previous code block. The actual issue is that line 87 should be outside the code block, so the code block starting at line 83 should be properly closed before line 87, not after it.