How gainsborouo/mch_dev-interview-project works
Project type and purpose
• This is a single-page application (SPA) built with Vue.js and Vite.
• Purpose: render a personal introduction section and a “Historical Hackathon Websites” page by fetching data from a remote backend API.
• It’s delivered as a static site via GitHub Pages with a CI/CD pipeline in GitHub Actions.
File structure
• Top-level:
• .github/workflows/deploy.yml → CI/CD pipeline to build & deploy to GitHub Pages
• README.md, LICENSE, .gitignore → docs and project metadata
• frontend/:
• package.json, package-lock.json → dependencies (Vue, Vite, Axios)
• vite.config.js → build config for Vite
• public/ → static assets (images, manifest)
• src/ → application code
– main.js → app bootstrap with Vue and Vue Router
– router/index.js → client-side routes (Introduction, HistoricalWebsites)
– App.vue → root component containing navbar & footer
– components/ → reusable UI parts (Navbar.vue, Footer.vue)
– views/ → page-level components (Introduction.vue, HistoricalWebsites.vue)
– assets/styles.css → global CSS including RWD grid styles
README for additional insights
• Two tasks: style the intro header and implement a responsive grid for websites.
• Data comes from a documented external API (websites array).
• Deployment steps involve forking, dev server (npm run dev), and enabling GitHub Pages.
a. Main components
• Developer workstation (VS Code, Git, npm)
• GitHub repository (main branch, gh-pages branch)
• GitHub Actions CI/CD workflow
• Static site host (GitHub Pages)
• Browser/client (executes SPA)
• External backend API (provides websites data)
b. Relationships & interactions
1. Developer pushes code → triggers GitHub Actions
2. Action runs “npm install” & “npm run build” via Vite
3. Build output (dist/) is published to gh-pages branch → GitHub Pages serves assets
4. User’s browser fetches index.html & JS/CSS assets from GitHub Pages
5. SPA loads, Vue Router controls navigation
6. HistoricalWebsites.vue uses Axios to GET /websites from External API
7. API responds with JSON → SPA renders grid
c. Architectural patterns & design principles
• SPA pattern with client-side routing (Vue Router)
• Component-based UI (Vue components in src/components & src/views)
• Responsive design using CSS grid in assets/styles.css
• CI/CD for “build → deploy to static host” via GitHub Actions
• Separation of concerns: presentation (Vue), styling (CSS), data layer (Axios)
d. Key technologies/frameworks
• Framework: Vue.js 3
• Build tool: Vite
• Routing: Vue Router
• HTTP client: Axios
• CI/CD: GitHub Actions
• Hosting: GitHub Pages