How ergrato-dev/bc-oop-java works
Project Type and Purpose
• This is neither a traditional web service nor a micro-service suite, but an open-source educational content repository (“Bootcamp POO Java”) aimed at delivering a 10-week Java/OOP training.
• Key indicators:
• Massive folder hierarchy under bootcamp/ (weeks 0–9, each with theory/practice/resources/evaluation).
• _docs/ for instructor guides and policies.
• .github/ scripts for automation (auto-commit, cron).
• No running server code; it’s Markdown + Java examples + shell scripts.
File Structure Analysis
• Top-level directories:
• bootcamp/ → weekly modules (theory, practice, resources, rubrics).
• _docs/ → internal documentation (IDE setup, anti-plagiarism policy, tutorial scripts).
• scripts/ & .github/scripts/ → automation (auto-commit service, cron installation).
• Key patterns:
• Modular content per week (reusable structure).
• CI/automation separate from content.
• No backend/frontend code; Java examples live inside each module’s practice folder.
Insights from README
• Purpose: deliver 40-hour intensive bootcamp covering AOO, UML, Java best practices.
• Tech stack: JDK 17+, any Java IDE, Git/GitHub, no dedicated runtime or server.
• Contributions: via GitHub PRs, issues, discussions—hence integration with GitHub workflows.
a. Main Components
1. Users (Students / Instructors)
2. Local Dev Environment (IDE + Java JDK)
3. Content Repository (GitHub repo hosting Markdown + Java samples)
4. Automation Layer (.github/scripts + scripts/ for auto-commit & cron jobs)
5. Collaboration Platform (GitHub Issues, PRs, Discussions)
6. External Resources (Oracle Docs, GeeksforGeeks, Replit)
b. Relationships / Data Flows
• Users clone/fork the Content Repository → open in IDE/Java → read theory, run code samples.
• Automation Layer runs on GitHub (cron timers, auto-commit service) to keep materials updated.
• Users submit PRs/issues back into Collaboration Platform → integrated into the Content Repository.
• External Resources linked from content; users follow these outwards for deeper study.
c. Architectural Patterns
• Modular content delivery: weekly modules are self-contained sub-components.
• Separation of concerns: content (Markdown/Java) vs. automation (shell scripts).
• Open-source collaboration: git-driven workflow, contribution guidelines.
d. Key Technologies
• Markdown docs for theory & practice.
• Java 17+ examples in each module.
• Shell scripts for auto-commit and cron jobs.
• GitHub Actions/cron integration for repository maintenance.
Essential Details
• Both static content (Markdown, SVGs) and dynamic processes (scripts, user contributions).
• Don’t over-engineer—focus on showing how educational material flows from repository to student, and how feedback/automation flows back.