For Contributors KeyComponents Extractor

🏠 Extractor

Useful Information & Resource

Design

Description, Diagram Examples [System flowcharts, ER-Diagram, Data Flow Diagram, Input Process Output, Module Diagram, Process flow diagram and ...]

Tools

• Mermaid Diagrams: Create diagrams with the Mermaid Live Editor, one of the most popular Mermaid diagram tools. > Here is the link to Mermaid Documentation.
• Draw.io: Here are some example draw.io diagrams and templates from official.
• Lucidchart: Here is the link to create the diagrams with Lucidchard

---

1. Project Structure (TBD)

project-root/
├── backend/              # Backend modules
├── frontend/
├── simulator/
├── Pipfile / Pipfile.lock
├── Dockerfile / docker-compose.yml
└── main.py               # FastAPI entry point

• Modular organization: each submodule (e.g., extractor, simulator) is encapsulated.

---