How jaehoonsong12/ydjs_academic works
Project Type & Purpose
• Monorepo “academic toolkit” for teaching CS basics (AP CS Principles, Python intro, Java OOP).
• Contains language‐specific code examples, exercises, design‐pattern demos, build/test scripts, and documentation.
High-Level File Structure
• Top-level directories:
• docs, images – markdown/textual reference materials
• script – Bash scripts to initialize, build, run, test (for Java & Python tracks)
• async-*, std*-* – stand-alone Java/Python exercise folders
• ydls-cython – C/C++/Java/Python case studies
• ydls-java – a Gradle-based Java application with src/main, src/test, buildSrc, etc.
• Configuration & metadata: .gitignore, JDK.md, LICENSE, README.md
Key Components to Model
a. Developer Workstation (IDE/VSCode)
b. Monorepo Root
– Documentation (docs/, images/)
– Environment Scripts (script/)
– Language Subprojects
· Java Examples & Tests (async-*/ std*-*/ ydls-java/)
· Python Examples (async-anderson-app, std05-sean-coding, ydls-cython/main/python/)
· C/C++/Cython Examples (ydls-cython/main/cxx/)
c. Build & Test Tools
– Java: Gradle, JDK, JUnit jars
– Python: virtualenv, requirements.txt
d. External Services
– GitHub (remote repo)
– Google Drive (hosted documentation)
Relationships & Data Flows
• Developer → clones monorepo from GitHub.
• Developer → runs script/*-init.sh → sets up JDK or Python venv.
• IDE invokes build (Gradle for Java, Python scripts for Python track).
• Build tool compiles/interprets source → runs tests (JUnit → console reports; Python unittest/pytest).
• Developer views/reference docs locally or via Google Drive link.
• After changes, Developer → runs script/git03-branch+push.sh → pushes to GitHub → triggers CI (optional).
Architectural Patterns & Principles
• Monorepo with logical language- and course-based modules.
• Separation of concerns:
• Docs vs. code
• Language runtimes (Java vs. Python vs. C/C++)
• Build scripts as single‐entry orchestration layer
• Use of standard build & test frameworks (Gradle, JUnit, Python venv & requirements)