How zyronon/typewords works
Project type and purpose
• This is a front-end–only Single-Page Application (SPA) built with Vue (Composition API), Vite, and static hosting.
• Purpose: A self-contained English learning tool (“TypeWords”) offering word and article practice, local persistence, optional translation via external APIs, and offline-capable caching.
File structure
Top-level overview:
• src/ → Vue application source (components, pages, stores, hooks, utils)
• js_node/ → Node.js scripts for data preprocessing (dictionaries, crawlers)
• scripts/ → Build/deploy helper scripts (OSS upload, sitemap generation)
• Dockerfile, docker-compose.yml → Dev container definitions
• .github/workflows → CI pipelines for build & deploy (Aliyun OSS, GitHub Pages)
• netlify.toml, vercel/ → Hosting configuration
• README, docs/ → Project docs & contribution guide
Architecture insights from README
• Static-hosted SPA; data persisted locally (indexedDB/localStorage).
• Translation feature via Baidu or other external translation services (src/libs/translate).
• CI/CD pipelines deploy build output to multiple CDNs/hosts (OSS, Vercel, Netlify).
Elements
• Clear labels: “Browser”, “Service Worker”, “Vue SPA”, “LocalStorage/IndexedDB”, “CDN/OSS”, “Translation API”, “CI/CD”
• Browser → CDN (fetch assets)
• Service Worker ↔ CDN (cache & serve)
• SPA → LocalStorage (read/write)
• SPA → Translation API (HTTP request)
• GitHub Actions → Build artifact → CDN deployment
• Orange for external services
• Rounded rectangles for CI/CD pipelines
Detailed breakdown
• Split “Vue SPA” into sub-components:
• Router (router.ts)
• Stores (src/stores)
• Pages (src/pages/**)
• Components (src/components/**)
• Utilities & hooks (src/utils, src/hooks)
• “Public Data” area: JSON dictionaries & sound assets served from CDN.
• “js_node” scripts as an offline data-preparation step (not in production runtime).