How gaye-lamine/voyage-au-pays-des-histoires works
Project type and purpose
• This is a full-stack (mostly client-driven) Nuxt.js application (“Voyage au Pays des Histoires”) for interactive children’s storytelling.
• It uses a Vue-based front end (Nuxt) with server-side support in the server/ folder, client-side state management in stores/, and is intended to be deployed on Netlify.
File structure
• Top-level:
• app.vue, layouts/, pages/ → Nuxt front end
• stores/ → Pinia or Vuex-style stores (game state)
• server/ → TypeScript server APIs or server middleware
• public/ → static assets (robots.txt, images, audio files?)
• nuxt.config.ts, tsconfig.json, netlify.toml → configuration and deployment
• Key patterns:
• Nuxt SSR/Static-Site Generation with routing under pages/
• Component/layout hierarchy under layouts/ and root app.vue
• Single store module for game logic in stores/game.ts
• Likely serverless functions (Netlify) or Nuxt server endpoints under server/
README for additional insights
• Core features: interactive reading with Web Speech API, chapter navigation, comprehension quizzes
• Technology stack: Nuxt.js, Vue, TypeScript, Web Speech API, Netlify
a. Main Components
• Client Browser (end user)
• Nuxt Front-End App
• Page components (pages/*.vue)
• Layout (layouts/default.vue)
• Global store (stores/game.ts)
• Server/API Layer (server/)
• External Services
• Web Speech API (in-browser)
• Netlify Hosting & Build
• Static Content (public/)
b. Relationships & Interactions
• User ↔ Browser UI: navigates pages, interacts with quiz and controls
• UI → Store: reads/writes game state (current chapter, questions answered)
• UI → Server APIs: (if any) fetch story content or quiz data
• UI → Web Speech API: sends text for TTS, receives audio stream
• Build Process: Git → Netlify CI (via netlify.toml) → deploy static + serverless functions
c. Architectural Patterns
• Component-based MVC/MVVM in Nuxt/Vue
• Single-page application with server-side rendering or pre-rendering
• Central store (Pinia/Vuex) for state management
• Serverless functions or API endpoints under server/
d. Key Technologies
• Nuxt.js (Vue framework)
• TypeScript
• Web Speech API
• Netlify (hosting + serverless)
Detailed & Comprehensive Capture
• Global store module and how pages consume and mutate it
• If the server/ folder contains custom endpoints, list them explicitly (e.g., /api/getChapter)
• That static story assets (text, audio) are served from public/
• That Netlify uses netlify.toml to route serverless functions and build the Nuxt app