How ramantehlan/moi works
Project Type and Purpose
• This is a static, single-page personal site template built with Vue.js (and a bit of jQuery), delivered entirely as client-side assets.
• Purpose: allow users to fork, supply content via a JSON file, and deploy to GitHub Pages (or any static host) without running a server or database.
File Structure Highlights
• Top-level:
• config files (.circleci/config.yml, .eslintrc.js, .gitignore)
• README.md, data.json (the user-editable content)
• index.html – the shell that loads the app
• robots.txt, sitemap.xml – SEO/static host helpers
• /images – media assets
• /style – compiled CSS (themes, variables)
• /script – bundled JS (Vue app, runtime, vendor code)
• No “backend” folder or server code—everything runs in the browser.
Key Architecture Insights from README
• The app fetches data.json at runtime and feeds it into a Vue.js frontend.
• Themes and layout are driven by CSS custom properties and the JSON “themes” section.
• Content sections are pre-defined in HTML and populated dynamically (e.g., about, work, projects).
• Build artifacts live on the master branch; source code (unbundled) lives on the source branch.
• CI/CD via CircleCI likely automates bundle generation and deployment to GitHub Pages.
Main Components
a. Developer & CI/CD
• GitHub repository (source branch → build pipeline → master branch)
• CircleCI (pulls source, runs linter, webpack build, pushes artifacts)
b. Static Hosting
• GitHub Pages or any CDN/host serving index.html, script/*.js, style/*.css, data.json, images/
c. Client (User’s Browser)
• Asset loader (HTML → CSS + JS bundles)
• Vue.js runtime: fetches data.json, applies themes, renders sections
• jQuery usage (if any) for DOM manipulations
d. External Services (optional)
• Google Analytics (tracking snippet injected via data.json)
• Google Search Console (verification via meta tag in data.json)
Relationships & Data Flows
• Developer commits → GitHub → CircleCI → builds JS/CSS → deploy to hosting.
• User’s browser request → static host → serves index.html → loads CSS/JS → app fires.
• App runtime fetches data.json → renders dynamic content.
• Optionally sends pageview data to Google Analytics.
Architectural Patterns & Principles
• “Jamstack” style: pre-build assets + client-side rendering from a flat JSON file.
• Fully decoupled frontend: no server logic beyond static file serving.
• Build-time vs. runtime separation: webpack bundles built by CI; JSON drives runtime content.
Essential Elements to Capture
• CI/CD process and branches (source vs. master)
• Static asset types and where they live
• Runtime data flow (JSON → Vue.js → rendered HTML)