How masnormen/ziyo works
High-Level Architecture Overview
a) Frontend Application (ziyo-fe)
• Next.js-based web application
• Client-side search interface
• Kanji detail pages
• SEO and OpenGraph optimization
b) Backend Service (ziyo-be)
• Hono.js-based API server
• OpenGraph image generation
• SQLite database integration
• Typesense integration
c) Search Engine
• Typesense instance
• Kanji index and search functionality
Component Relationships
a) Client Layer:
• Sub-components:
• Search UI
• Kanji detail views
• Settings management
• Query hooks layer
b) API Layer:
• Connections to:
• OpenGraph image generator
• SQLite database
• Typesense search engine
c) Data Layer:
• SQLite database (kanji.sqlite)
• Typesense search engine
• Static assets
Specific Implementation Details
• Blue rectangles for frontend components
• Green rectangles for backend services
• Purple hexagons for external services
• Red diamonds for critical infrastructure components
Following interactions:
• User → Frontend: Search requests and navigation
• Frontend → Backend: API calls
• Backend → Typesense: Search queries
• Backend → SQLite: Kanji data retrieval
• Backend → OpenGraph: Image generation
[Client Layer (Next.js)]
• ↓
[API Layer (Hono.js)]
• ↓
[Data Layer (Typesense + SQLite)]
Search functionality as it's the core feature
• Typesense integration
• Multiple search methods (readings, meanings)
• Real-time search results
Development tooling
• Docker containers
• GitHub Actions workflows
• Type generation scripts