How riceball-tw/my-note works
Main Components
A. Frontend Layer:
• Vue Components Structure
• UI Components (shadcn-vue components)
• Components
• Pages (index, signin, signup)
• Asset Management
• Composables
• Middleware (auth)
B. Backend Layer:
• API Routes Structure
• Notes API endpoints
• User Authentication endpoints
• Database Layer (using Drizzle ORM)
• JWT Authentication Service
┌─────────────────────────────────────────────────────────┐
• Client Browser │
• ┘
• ↕
┌─────────────────────────────────────────────────────────┐
• Frontend Layer │
• ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌────────┐ │
• Pages │ │ UI │ │ Note │ │ Auth │ │
• Components│ │Components│ │Middleware│ │
• ┘ └──────────┘ └──────────┘ └────────┘ │
• ┘
• ↕
┌─────────────────────────────────────────────────────────┐
• Backend Layer │
• ┌──────────┐ ┌──────────┐ ┌──────────┐ │
• Notes │ │ User │ │ JWT │ │
• API │ │ API │ │ Service │ │
• ┘ └──────────┘ └──────────┘ │
• ┘
• ↕
┌─────────────────────────────────────────────────────────┐
• Database Layer │
• ┌──────────────────────────────────────────┐ │
• Drizzle ORM │ │
• ┘ │
• ┘
Important Details to Highlight
A. Frontend Components:
• Hierarchy of UI components
• Authentication flow
• Routing structure
B. API Layer:
• CRUD operations (/api/notes)
• User authentication endpoints (/api/user)
• JWT handling (plugins/jwt.server.ts)
C. Database Schema:
• Main entities from schema.ts
• Relationships between entities
Technical Stack Callouts
• Nuxt.js (Frontend Framework)
• Vue.js (UI Framework)
• Tailwind CSS (Styling)
• Drizzle ORM (Database ORM)
• JWT (Authentication)
Interactions to Emphasize
• Authentication flow between frontend and backend
• CRUD operations flow
• Middleware interactions
• Database transactions
Remember to:
• Use consistent styling
• A title and version number
• Notes for any non-obvious architectural decisions
• Document any external service integrations