How la-chatte-2-0/code-amienois works
Project type and purpose
• This is a client‐side single‐page application (SPA) built with Vue 3, TypeScript, and Vite.
• It has no custom backend code; it’s deployed as a static web app (Azure Static Web Apps via GitHub Actions).
• Purpose: present a rich, multi‐page interactive site with images, audio, and dynamically rendered content (articles, folklores, checklists, etc.).
File structure
• Top‐level files & dirs:
• index.html – SPA entry point
• public/ – static assets (images, sound, robots.txt)
• src/ – application source code
– main.ts – app bootstrap
– router/ – Vue Router configuration
– layout/ (MainLayout.vue) – global shell
– pages/ – route‐level views (Bacchus.vue, CheckList.vue, …)
– components/ – reusable Vue components (shared/, articles/, folklores/)
– core/ – business‐logic modules (checklist.ts, page.ts, historique_croix.ts)
– sass/ – SCSS base files
• Configuration files: tsconfig.json, vite.config.ts, staticwebapp.config.json, CI workflows (.github/workflows/*.yml).
Key README insights
• It’s based on the official “Vue 3 + TypeScript + Vite” starter template.
• Emphasizes <script setup> SFCs, vue-tsc for type‐checking.
a. Main components:
1. Developer/CI Pipeline
– Local dev (VS Code + Vite dev server)
– GitHub Actions (build/test)
– Azure Static Web Apps deployment
2. Hosting/CDN Layer
– Azure Static Web Apps (edge network, blob storage)
3. Client (Browser)
– index.html + bundled JS/CSS served from CDN
– Vue 3 runtime + Vue Router + TypeScript runtime checks
4. Application subcomponents (inside the browser):
– Router – handles navigation to pages
– Layout – global wrappers (MainLayout.vue)
– Pages – screen‐level views (CheckList.vue, Codex.vue, etc.)
– Feature Components – articles, folklores modules under src/components
– Core modules – business logic (checklist.ts, historique_croix.ts, page.ts)
– Assets – images, audio served from public/
b. Relationships & interactions:
• Developer pushes to GitHub → GitHub Actions builds (Vite, vue-tsc) → artifacts deployed to Azure Static Web Apps → CDN caches assets.
• Browser requests index.html → bootstraps Vue app → Router loads page components → page components import shared & feature components and core modules → components fetch static assets (images, audio) via HTTP.
c. Architectural patterns & principles:
• SPA / client‐side routing pattern.
• Component‐based UI (Vue SFCs, Composition API).
• Separation of concerns: pages vs. shared components vs. core logic.
• CI/CD pipeline for automated build and deployment.
d. Technologies, frameworks & libraries:
• Vue 3 Composition API (<script setup>)
• Vue Router (src/router)
• TypeScript
• Vite (dev server + build tool)
• SASS for styling
• Azure Static Web Apps / GitHub Actions for hosting
Elements
• Dev → GitHub → CI/CD → Azure
• Browser → Azure (index.html, JS, CSS, assets)
• Within Browser: Router → Pages → Components → Core modules
• Components → public assets (images, audio)
• Blue for developer/CI/CD stages
• Green for hosting/CDN
• Orange for client‐side runtime
• Gray for static assets