How oangelo/calculo-vetorial-exploracao-espacial works
Project type and purpose
• This is a static, content-driven educational website built around HTML/CSS and Reveal.js slide decks.
• Its goal is to serve course materials (exercises, slide decks, visualizations) via GitHub Pages.
Main components
a. Developer Environment
• Node.js & npm (package.json, package-lock.json)
• Code styling tools (Prettier, Husky pre-commit hooks)
b. Source Code Repository (GitHub)
• Directories of static content:
– slide-decks/ (Reveal.js presentations)
– exercicios/ (chapter exercises and templates)
– visualizacao/ (interactive visualizations)
– investigacao/ (markdown investigation blocks)
– img/ (images and SVGs)
• Configuration files: .gitignore, .prettierrc, PROVAS.MD
• Build scripts and dependencies declared in package.json
c. Continuous Integration / Deployment (CI/CD)
• .github/workflows/deploy-revealjs.yml — upon push, installs npm deps, assembles slide decks, and pushes static files to GitHub Pages
d. Hosting Layer
• GitHub Pages serves the generated static site at the project’s GitHub Pages URL
e. End Users (Students/Instructors)
• Web browsers that request pages, download static assets, and render the content
Relationships and interactions
1) Developer edits content or code locally →
2) Husky runs pre-commit checks (linting, formatting) →
3) Push to GitHub triggers CI workflow →
4) CI installs dependencies, runs build steps (if any), packages static files →
5) CI deploy step publishes to GitHub Pages →
6) End user browser requests page →
7) GitHub Pages serves static HTML/CSS/JS →
8) Browser renders interactive slides, exercises, and visualizations
Architectural patterns and design principles
• Static Site / Content-as-Code: all teaching materials live as versioned files
• CI/CD Pipeline: full automation of build & deploy to ensure consistency
• Modular Content Structure: each chapter and asset type is grouped in its own directory