How strongaya/strong-aya-info-portal works
Project Type and Purpose
• This is a proof-of-concept, static web portal that aggregates and displays patient-related statistics (STRONG AYA Info Portal).
• It is implemented as a GitHub Pages site (“web/” folder), with scheduled GitHub Actions workflows that fetch and prepare data from a Vantage6 server and update Datawrapper charts.
File-Structure Analysis
• Top-level directories and files:
– “web/”: all static assets (HTML, CSS, JS, images) served to end users
– “scripts/”: Python integration scripts for Vantage6, flashcard construction, Datawrapper uploads
– “data/”: raw and processed data artifacts (JSON output from Vantage6, generated CSV flashcards)
– “.github/workflows/”: two workflows—one to retrieve and process data (“update_data.yml”), one to build/publish the site (“publish_web.yml”)
• Configuration and artifacts:
– “scripts/requirements.txt”: Python dependencies
– “plotting_info.json”: metadata for Datawrapper charts
– “STRONG-AYA-Cancer-Info-Portal-Design.mp4”: full portal design concept
README Insights
• Describes external dependencies: Vantage6 (distributed computation), GraphDB instances on nodes, Datawrapper for charting
• Specifies this is a POC hosted on GitHub Pages with periodic data updates via GitHub Actions
• References an external descriptive-statistics algorithm repository used by the integration scripts
Main Components
a. GitHub Repository (Source of truth)
b. GitHub Actions
– Workflow A (“update_data.yml”):
• Runs vantage6_integration.py → sends task to Vantage6 server
• Receives JSON results → stored in data/raw/vantage6_result.json
• Runs construct_flashcard.py → generates CSV flashcards in data/flashcards/
• Runs datawrapper.py → pushes updated charts to Datawrapper
– Workflow B (“publish_web.yml”):
• Packages “web/” folder and processed data
• Deploys to GitHub Pages branch
c. External Services
– Vantage6 server + distributed GraphDB nodes (compute and RDF data)
– Datawrapper API (chart hosting and embed)
d. Static Web Frontend
– HTML/CSS/JS in “web/”
– JS modules (e.g. retrieve_positive_count.js) fetch embedded Datawrapper charts or static CSV as needed
– User interacts with modules for chemotherapy, radiotherapy, emotional/physical/role functioning
e. Data Storage
– JSON in “data/raw/” (intermediate)
– CSV in “data/flashcards/” (final artifacts used by frontend)
– plotting_info.json drives chart configuration
Architectural Patterns and Principles
• Serverless static-site hosting (GitHub Pages)
• CI/CD pipelines for data ingestion and deployment (GitHub Actions)
• Separation of concerns:
– Data ingestion and processing (scripts + workflows)
– Charting service (Datawrapper)
– Presentation layer (static HTML/CSS/JS)
• Extensibility points: add new modules by dropping HTML/JS/CSS and mapping new CSV or Datawrapper chart IDs