How hackyourfuture-cph/programme works
Project Type and Purpose
• This is a documentation‐centric monorepo that “Documents the HYF programme, courses and modules.” It contains all of the markdown content for current courses (/courses/*), legacy material (/legacy/*), shared modules (/shared-modules/*), contribution guidelines (/contributing/*), plus a small custom support toolchain (/support/*) and CI configuration (.github/workflows/lint.yml).
File Structure Analysis
• Top-level directories:
• courses/ – live curriculum grouped by Foundation, Backend, Frontend, Pre-Course
• legacy/ – archived course material in the same structure
• shared-modules/ – reusable lesson plans and assignment templates
• contributing/ – governance, meeting notes, proposals
• support/ – a small TypeScript CLI tool for parsing/validating/watch tasks
• Config & tool files:
• package.json / package-lock.json – Node.js project manifest
• support/tsconfig.json – TypeScript compiler settings
• .markdownlint.yaml, .prettierignore – formatting and linting rules
• GitHub Actions workflow for linting (.github/workflows/lint.yml)
README Insights
• Confirms the repo’s role as the single source of truth for HYF CPH’s curriculum docs.
a. Main Components
• Content Store
• “Courses” content
• “Legacy” content
• “Shared-modules”
• “Contributing” docs
• Support Toolchain (Node.js + TypeScript scripts)
• parse.ts, validateLinks.ts, watch.ts – a local CLI that scans and validates all .md files
• CI Pipeline (GitHub Actions)
• Linting / markdown checks triggered on push/PR
• Development Environment
• Developers clone repo, install via npm install, run npm run watch or npm run lint
b. Relationships & Data Flow
• Developers → (edit/add) → Content Store
• Support Toolchain → (reads) → Content Store → (reports) → Developer console
• CI Pipeline → (on push) → runs Support Toolchain (lint/validate), posts status back to GitHub
c. Architectural Patterns & Principles
• Monorepo pattern: all curriculum modules and tooling live in one repository
• Separation of concerns: content vs. tooling vs. CI vs. contribution docs
• Convention-over-configuration: directory names define module type and stage (current vs. legacy)
d. Key Technologies & Frameworks
• Markdown for content
• Node.js + TypeScript for custom scripts
• MarkdownLint and Prettier for formatting
• GitHub Actions for CI