How naiplawan/pos-retail-shop works
Project type and purpose
• This is a full-stack retail price-tracking application with two delivery modes:
• Web (Next.js + React + TailwindCSS)
• Desktop (Electron shell wrapping the same Next.js app)
File structure (key directories)
• app/
• Next.js 13 “app router” directory with pages (layout.tsx, page.tsx, checklist pages) and API routes under app/api (prices, checklist, summary).
• components/
• Reusable React components (dashboard, charts, tables) and an internal UI library under components/ui (Radix-based controls).
• electron/
• Electron main and preload scripts that spin up a desktop shell hosting the Next.js app.
• lib/
• Database connectors (lib/database-electron.ts) using Prisma + Supabase, PDF-generation utilities (lib/pdf-document.tsx, jsPDF wrappers), export logic.
• hooks/
• Custom React hooks (use-mobile, use-toast).
• types/
• TypeScript definitions (electron, domain models).
README for technical stack and flow
• Frontend: Next.js + React + Tailwind + RadixUI + Chart.js/Recharts
• API & Data: Next.js API routes → Prisma ORM → Supabase
• PDF export: React-PDF + jsPDF
• Desktop: Electron → serves local Next.js endpoint; uses IPC via preload.js
a. Main components
• Clients:
– Web Browser (Next.js SSR/CSR pages)
– Electron Desktop (Electron Main + Preload + Next.js UI in a BrowserWindow)
• Backend/API: Next.js API Routes (app/api/\*)
• Database: Supabase (PostgreSQL) accessed via Prisma
• PDF/Export Service: React-PDF/jsPDF library invoked in the frontend
• Utility Layer: lib/ functions (database-electron, export, utils)
• External Services: Supabase (Auth & DB), optionally analytics or storage if added
b. Relationships and interactions
• Web/Electron UI → HTTP calls to Next.js API → CRUD operations on Supabase
• Electron Main ↔ Preload.js ↔ Next.js UI (IPC channel for native OS hooks or filesystem operations)
• Next.js API → Prisma client → Supabase
• UI components → Chart.js/Recharts for rendering data
• UI export features → lib/pdf-document.tsx → jsPDF to generate & download PDF
c. Architectural patterns & design principles
• Layered architecture: Presentation (React UI) → Application/API (Next.js Routes) → Data Layer (Prisma → Supabase)
• Component-based UI with a design system (components/ui)
• Single code-base deployed to both Web and Electron targets
• Separation of concerns: hooks/ for reusable logic, lib/ for utilities, API routes for business logic
d. Technologies & frameworks to annotate
• Next.js 13 (app router)
• React + TailwindCSS + RadixUI
• Prisma ORM + Supabase
• Electron (main, preload, BrowserWindow)
• Chart.js / Recharts
• React-PDF / jsPDF
Elements
• Clear labels: e.g., “Next.js API Routes (app/api/prices, checklist, summary)”
• UI → API (HTTP)
• API → Database (SQL / Prisma)
• Electron Main ↔ UI (IPC)
• UI → PDF Export library (client-side)
• Blue for client-side components (React pages & components)
• Green for backend services (Next.js API)
• Orange for data stores (Supabase)
• Purple for desktop shell (Electron)