How anabrnjasevic/nuxt-maps works
Project type and purpose
• This is a full-stack single-page application (SPA) built on Nuxt 3 (Vue 3 + SSR/SSG).
• The README calls it a “Nuxt 3 Minimal Starter,” but the file tree shows custom pages, Vue components, composables (business logic hooks), middleware (auth), static assets, and a “server/api” folder with REST-style endpoints (PDF generation, directions, place lookup, data submission).
File structure
• Top-level Nuxt config: nuxt.config.ts, tsconfig.json, tailwind.config.js
• Frontend/UI:
• pages/ – Vue page components (index.vue, signup.vue, basicsearch.vue, etc.)
• components/ – reusable UI widgets (modals, buttons, date & type pickers, map, location picker)
• assets/css/main.css – custom Tailwind/CSS styles
• public/ – static assets (videos) served as-is
• Frontend logic & state:
• composables/ – Pinia-style hooks (useGetPlaces, useDownloadPDF, etc.) encapsulating API calls and reactive state
• middleware/auth.js – route guarding for authenticated pages
• Backend/API:
• server/api/ – serverless endpoints (Nuxt 3’s built-in Nitro server) handling:
• getPlaces.js → external Places API
• getDirections.js → external Directions API
• downloadPDF.js → PDF generation service
• sendData.js → data persistence or external integration
• server/tsconfig.json – TypeScript config for server code
• Package management: package.json, package-lock.json
README for additional insights
• Standard Nuxt 3 setup instructions, dev/prod scripts, and link to Nuxt deployment docs.
• Client (browser)
• Pages layer (Nuxt router)
• Vue components & composables
• Middleware (auth)
• Nuxt server (Nitro)
• Serverless API routes under /api/*
• External services
• Third-party Maps & Directions API
• PDF generation engine
• Data storage or external data receiver (if applicable)
• Static asset store
• CDN or Nuxt public/ for videos/CSS
b. Relationships & data flow:
1. User → Browser → Nuxt page (SSR/CSR)
2. Page/component invokes a composable (e.g., useGetPlaces)
3. Composable calls /api/getPlaces (via $fetch or fetch)
4. Nitro API handler queries external Places API → returns JSON
5. Component renders results; user triggers another action (e.g., generate PDF)
6. Composable calls /api/downloadPDF → Nitro endpoint calls PDF service → returns file stream or link
c. Architectural patterns & principles:
• Modular UI (atomic Vue components + composables)
• Clear separation of concerns:
• UI in components/
• Business logic in composables/
• Routing in pages/
• Auth in middleware/
• Server/API in server/api/
• Serverless functions (Nitro) for back-end without a separate Node.js app
d. Key technologies/frameworks:
• Nuxt 3 (Vue 3, Nitro, SSR/SSG)
• Tailwind CSS (via tailwind.config.js)
• TypeScript (configs in root and server)
• Serverless API routes (Nitro)
• External REST APIs (Google Maps, PDF service)