Qwerty Learner Project Documentation

中文

Welcome to the documentation for the Qwerty Learner project! This monorepo contains both the frontend (web) and backend (server) applications, designed for efficient vocabulary learning and management.

Project Structure

qwerty-learner-next/
├── web/      # Frontend (React, Vite, TypeScript)
├── server/   # Backend (NestJS, TypeORM, PostgreSQL)
└── docs/     # Documentation

Features

• Modern web frontend with React, Vite, Zustand, Jotai, MUI Joy, and more
• RESTful backend API with NestJS, TypeORM, PostgreSQL
• User authentication, vocabulary management, error book, statistics, and more
• Internationalization (i18n)
• E2E and unit tests
• Dockerized deployment
• CI/CD ready

Quick Start

See Setup & Development for detailed instructions.

Prerequisites

• Node.js >= 20.10.0
• pnpm >= 9.5.0

Install dependencies

pnpm install

Run frontend (web)

cd web
pnpm dev

Run backend (server)

cd server
cp .env.example .env
pnpm start:dev

Deployment

See Deployment Guide.

Contribution

See Development Guide and Conventions.

Technology Stack

Frontend (web)

• React 19, Vite, TypeScript
• Zustand, Jotai, TanStack Query/Router/Table
• MUI Joy, @tabler/icons-react, Radix UI
• ECharts, Dexie, SWR, i18next, Playwright

Backend (server)

• NestJS 10, TypeScript
• TypeORM, PostgreSQL
• @nestjs-modules/mailer, BullMQ, Swagger
• Jest, ESLint, Prettier, Docker

Documentation

• Setup & Development
• Architecture
• Database
• Security
• Testing
• Deployment
• Technologies
• Troubleshooting

License

MIT