How neosan974/myopenerp works
Project type and purpose
• This is a full-stack, server-rendered Nuxt 3 (Vue 3) application scaffolded as a “Minimal Starter.”
• It uses the Nuxt Nitro server engine (note the server/ folder and deno.lock) for API routes and server-side rendering.
• It integrates Supabase (PostgreSQL + Auth + Storage) as the primary backend service.
File structure
• At the root:
– app.vue: the root Vue component
– nuxt.config.ts: Nuxt configuration (plugins, modules, runtime settings)
– package.json + tsconfig.json + deno.lock: package, TypeScript, and Deno lockfiles
– public/: static assets (favicon, images, fonts)
• server/: custom Nitro server code and API endpoints
• supabase/: Supabase config & database seed scripts (config.toml, seed.sql)
README for additional insights
• Confirms a standard Nuxt 3 development flow (dev → build → preview)
• Points to Nuxt’s documentation—no bespoke architecture notes here, so we infer structure from the file tree
a. Main components
• Client (Browser or Mobile WebView)
• Nuxt 3 Application (SSR + SPA)
– Vue components (app.vue + pages/components folder)
– Nuxt Middleware & Plugins
• Nitro Server (serverless or Deno server)
– API routes in server/
– Server-side rendering engine
• Supabase Service
– PostgreSQL database
– Auth / JWT service
– Storage (optional)
• Public CDN / Static Assets
b. Relationships & interactions
1. Client ↔ Nuxt SSR/SPA
– HTTP(S) requests for pages & assets
– WebSocket (if used) or polling for real-time features
2. Nuxt SSR/SPA ↔ Nitro API
– Internal HTTP calls or direct function invocations for data‐fetching
3. Nitro API ↔ Supabase
– Secure REST / GraphQL calls to Postgres
– Auth token validation via Supabase Auth
4. Client ↔ Supabase (optional)
– Direct JS SDK calls for real-time subscriptions or storage uploads
c. Architectural patterns & design principles
• SSR + SPA hybrid: first-load SSR, then hydrate to SPA
• Serverless functions / edge functions using Nitro + Deno
• 12-factor app with environment variables for Supabase credentials
• “Backend-for-Frontend” pattern (Nitro layer abstracts Supabase)
d. Key technologies & libraries
• Nuxt 3 & Vue 3
• Nitro server engine (Deno runtime)
• Supabase JS SDK
• TypeScript
• Vite (build tool)
Elements
• Clear labels: “Browser Client,” “Nuxt 3 SSR,” “Nitro API (server/)”, “Supabase (Postgres + Auth)”
– Page & asset requests (Client → Nuxt)
– API calls (Nuxt → Nitro → Supabase)
– Real-time subscriptions (Client ↔ Supabase)
– Blue rectangles for front-end components
– Green for server/API
Detailed but focused
• Every major folder or module that influences runtime (e.g., server/, supabase/config.toml)
• Don’t clutter with every single utility file; group by responsibility (e.g., “Static Assets,” “API Endpoints”)