How studioconcertos/quartz works
Project Type and Purpose
• Quartz is a full-stack web application: an open-source, Nuxt 3-based slides engine for building and delivering ambitious presentations.
• The README calls out core use cases (landing pages, authentication, slide editing “Atelier,” real-time live view) and the tech stack (Nuxt 3, Supabase, UnoCSS).
File Structure
• Top-level directories:
• assets (GLSL shaders, static assets)
• components (UI building blocks, subdivided by feature: atelier, auth, dashboard, landing, node-components)
• layouts (Nuxt layouts)
• pages (routing: landing, auth, atelier, live, index)
• stores (Pinia/Vue stores for state: assets, atelier, auth, deck)
• composables (reusable hooks: context menu, element renderer, snapshot)
• server (Nuxt server routes or API endpoints, tsconfig for server‐side code)
• utils & types (helpers, TypeScript definitions)
• Config and build files: nuxt.config.ts, tsconfig.json, bun.lockb, package.json, .env.example, uno.config.ts
README Insights
• Confirms use of Supabase for Auth, Database (Postgres), Storage, Real-time.
• Emphasizes three main UIs: landing, dashboard/auth, atelier (slide editor), live view.
a. Main Components
• Client (Browser) running Nuxt 3 front-end
– Pages and layouts rendered via SSR/SPA
– Component tree: landing, auth, dashboard, atelier, live modules
– State management via Pinia stores and composables
– Asset pipeline: shaders, images, CSS (UnoCSS)
• API/Server layer (Nuxt server routes in server/)
– Custom endpoints if any (e.g., webhooks, business logic not in Supabase)
• Supabase Services
– Authentication (magic links, OAuth)
– Database (users, decks, slides, elements)
– Storage (images, assets)
– Real-time (subscriptions for live sessions)
• External Deployment/Hosting
– CI/CD (GitHub Actions), hosting (Vercel/Netlify/Edge functions)
b. Relationships and Data Flows
• Browser ↔ Supabase Auth (login/logout)
• Browser ↔ Supabase Database (CRUD decks, slides via client SDK)
• Browser ↔ Supabase Storage (upload/download assets)
• Browser ↔ Supabase Real-time (WebSocket) for live sessions and Atelier syncing
• Browser ↔ Nuxt Server Routes (if custom logic exists)
• Hosting/CD pipeline pulls from GitHub on push → builds Nuxt app → deploys static and server functions
c. Architectural Patterns & Design Principles
• Component-based UI (Vue 3 + Nuxt)
• Feature modules (atelier, auth, dashboard, landing, live)
• Separation of concerns:
– Pages for routing
– Components for UI
– Composables for logic
– Stores for state
• API-first / BaaS approach via Supabase
• Real-time synchronization for collaborative editing and live view
d. Key Technologies
• Nuxt 3 (SSR/SPA, file-based routing, server routes)
• Vue 3 components, Composition API (composables)
• Pinia for state
• Supabase JS SDK (Auth, Database, Storage, Realtime)
• UnoCSS for utility-first styling
• WebGL shaders (assets/shaders) for slide animations
• Bun or Node (bun.lockb vs package.json) for build/runtime
Crucial Details to Capture
• Client architecture: pages→components→stores→composables
• BaaS interactions: authentication, CRUD, real-time
• Asset usage: GLSL shaders and static assets
• Deployment pipeline and runtime environment