How willem3141/navi-reykunyu works
Main Components
a. Frontend Layer:
• As a web interface component with submodules:
• Study/Learning Interface (based on /frontend/src/study*.ts files)
• Dictionary Search Interface (based on frontend templates)
• Editor Interface (corpus, etymology, sources editors)
b. Backend Layer:
• Core Dictionary Engine (/src/dictionary.js, /src/annotatedDictionary.js)
• Authentication System (/src/auth.js)
• API Service (/src/api.js)
• Language Processing Components:
• Word Processing (verbs.js, nouns.js, adjectives.js)
• Phonology Handler (phonology.js)
• Translation Service (translations.js)
c. Data Layer:
• Database Connection (/src/db.js)
• Word Dictionary Storage (data/words.json)
Component Relationships
• HTTP/API requests between frontend and backend
• Data flow between backend and database
• Internal module dependencies
Key Architectural Patterns to Highlight
a. MVC-like Structure:
• Models: dictionary data and word processing
• Views: frontend templates (frontend/templates/)
• Controllers: API and route handlers
b. Modular Design:
• Clear separation between:
• Frontend assets (LESS, TypeScript)
• Backend services
• Data storage
Technical Stack Elements
• Node.js Backend (indicated by package.json)
• TypeScript Frontend (frontend/src/*.ts)
• LESS CSS Preprocessing (frontend/less/)
• EJS Template Engine (frontend/templates/*.ejs)
Additional Elements
a. Build/Deploy Pipeline:
• Gulp build process (gulpfile.js)
• Asset compilation flow
b. External Interfaces:
• OpenSearch integration (opensearch.xml)
• Public API endpoints
[User Interface Layer]
• ↓ ↑
[Frontend Application Layer]
• ↓ ↑
[API/Backend Services Layer]
• ↓ ↑
[Data Storage Layer]
Important Considerations:
Clear boundaries between
• Public-facing components
• Internal services
• Data management systems
Remember to indicate the scalability points and potential areas for extension, as this is an open-source project that others might want to build upon.