How oceam/sorghum-head works
Project Type and Purpose
• This is not a typical full-stack application or microservice system. It’s essentially a static documentation/data-hosting site on GitHub with links to supplementary datasets.
• Primary purpose: present figures, README information, and provide a download mechanism (Google Form) for large image datasets.
File Structure
• Top-level:
– LICENSE – repository license
– README.md – project overview, dataset descriptions, external download link
– figure/ – subdirectory containing project figures and its own readme.md
• No “src,” “backend,” or code components—this is static content.
• External dependency: Google Forms for dataset requests.
Extract Key Architecture Insights from README
• The site itself is hosted via GitHub (static markdown → GitHub Pages).
• Data download: user fills Google Form → receives email with download link.
• Figures (Sup3.jpg, etc.) are stored in the repo’s figure directory and rendered in the README.
Main Components
a. Users (Researchers/Breeders)
b. GitHub Repository (static site)
– README.md
– figure/ directory
c. GitHub Pages (or static-site hosting)
d. Google Forms Service (data request form)
e. Email Service (sends download link)
f. Dataset Storage (e.g., Google Drive or cloud bucket where large files reside)
Relationships and Data Flows
1. User visits GitHub Pages → views README and figures.
2. User clicks “Download dataset” link → redirected to Google Form.
3. User submits form → triggers Email Service.
4. Email Service delivers dataset download link.
5. User downloads data from Dataset Storage.
Architectural Patterns and Design Principles
• Static-site / CDN pattern for documentation.
• Client–server interaction only for data requests.
• Minimal back-end: entirely offloaded to external services (Google Forms + Email).
• Separation of concerns: documentation vs. data hosting.
Technologies and External Services
• GitHub + GitHub Pages (static hosting)
• Markdown renderer for figures and supplementary info
• Google Forms (front-end form, form submission handling)
• Email delivery (could be Google Forms built-in notification or Apps Script)
• Google Drive / Cloud Storage for large datasets