How otiozee/public works
Project type and purpose
• This is a monolithic “content-and-CI” repository for the 01-Edu educational system. It houses:
• Course materials and exercises (in the subjects folder)
• Language-specific test harnesses (in js and sh directories, plus a dom folder)
• Documentation (in docs)
• Miscellaneous tasks for hiring (“employment-tasks”)
• GitHub Actions workflows (.github/workflows) for automated testing and compliance checks
File structure
• Top-level directories
• .github/workflows – CI definitions (lint, tests, builds)
• docs – static documentation on database, setup, reviews
• dom – JS-based DOM exercises with Dockerfile and tests
• js – Node-based exercises and tests, plus Dockerfile in js/tests
• sh – Shell-script exercises with tests and entrypoints
• subjects – hundreds of individual exercise subfolders (Go, Rust, JS, HTML, etc.)
• employment-tasks – sample tasks for DevOps/dev interviews
• CI indicators
• Dockerfiles in dom, js/tests, sh/tests – build isolated test containers
• GitHub Actions YAMLs – orchestrate compliance, build, test
Components
a. Source repository (GitHub)
b. CI/CD Plane (GitHub Actions)
– Compliance checks (Prettier, shellcheck, link checker)
– Image build jobs (Docker builds for dom, js, sh)
– Test orchestration (shell tests, Node tests, DOM tests)
c. Content plane
– Documentation generator (static Markdown served via GitHub Pages – implied by CNAME)
– Course content store (subjects/*, docs/*)
– Test definitions (js/tests, sh/tests, dom/*.js)
d. Runner containers
– dom-runner (Dockerfile in dom/)
– js-runner (Dockerfile in js/tests/)
– sh-runner (shell environment for sh/tests/)
Relationships & data flows
1. Developer pushes code → GitHub repo
2. PR triggers GitHub Actions →
• Lint/compliance workflows
• Docker build jobs for each language/test harness
• Test jobs:
– sh-runner executes sh/tests via entrypoint.sh
– js-runner executes Node tests (Jest/Mocha)
– dom-runner executes DOM tests with headless browser
3. Test results & coverage feedback → GitHub status checks
4. On master merges → (optional) site deployment to GitHub Pages using CNAME
Architectural patterns & design principles
• Monorepo pattern: all exercises, tests, docs in one repo
• CI-as-infrastructure: all validation wired through GitHub Actions
• Containerized test harnesses: isolating language environments
• Static site delivery for documentation and exercise descriptions