README.zh-CN.md

English | Español | Deutsch | Français | Português | Русский | Українська | 日本語 | 한국인 | ไทย | Tiếng Việt | Bahasa Indonesia | 繁體中文 | 简体中文

学习英语，一次敲击，一点进步；记忆不再盲目，学习更高效，开源单词与文章练习工具

在线访问

https://typewords.cc

功能列表

单词练习

• 练习模式：跟写 / 听写 / 自测 / 默写
• 智能模式：记忆曲线自动计算学习单词，并通过默写加深记忆
• 自由模式：不受限制，自行规划
• 提供音标、发音（美音、英音）、例句、短语、近义词、同根词、词源、错误统计等功能

背文章

• 内置经典教材书籍，也可自行添加、导入文章，提供一键翻译、译文对照功能
• 跟打 + 默写双模式，逐句输入，自动发音，让背诵更高效
• 支持边听边默写，强化记忆

收藏、错词本、已掌握

• 学习单词时输入错误自动添加到错词本，方便后续复习
• 可主动添加到已掌握，后续学习时自动跳过
• 可主动添加到收藏中，以便巩固复习

高度自由

• 丰富的键盘音效
• 可自定义快捷键
• 高度定制化的设置选项

简洁高效

• 简洁设计，现代化UI，无广告
• 界面清爽，操作简单
• 不强制关注任何平台

词库

内置了常用的 CET-4 、CET-6 、GMAT 、GRE 、IELTS 、SAT 、TOEFL 、考研英语、专业四级英语、专业八级英语等词库。 尽可能满足大部分用户对背单词的需求，也非常欢迎社区贡献更多的词库。

运行

注：本项目可单独运行，数据保存在本地，换设备需手动备份数据，不影响正常使用；

方式一：从源码运行

本项目是基于Nuxt开发的，需要 node 环境来运行。

1. 安装 NodeJS，参考官方文档
2. 项目文件很大，推荐使用 git clone --depth 1 https://github.com/zyronon/TypeWords.git 命令只克隆最近一次提交。直接下载 Github 提供的 Download ZIP 功能是无法运行的
3. 在项目根目录下，打开命令行，运行pnpm install来下载依赖。
4. 执行pnpm run dev来启动项目，项目默认地址为http://localhost:5567
5. 在浏览器中打开http://localhost:5567 来访问项目。
6. 执行pnpm run generate打包项目文件

方式二：使用 Docker

使用 Docker 是最简单的运行方式：

# 从 Docker Hub 拉取镜像
docker pull zyronon/typewords:latest

# 运行容器
docker run -d -p 3000:80 --name typewords zyronon/typewords:latest

然后在浏览器中打开 http://localhost:3000 来访问项目。

或者使用 Docker Compose：

# 使用 docker-compose 启动
docker-compose up -d

# 停止服务
docker-compose down

或者本地构建并运行：

# 构建 Docker 镜像
docker build -t typewords .

# 运行容器
docker run -d -p 3000:80 --name typewords typewords

功能与建议

目前项目处于开发初期，新功能正在持续添加中，如果你对软件有任何功能与建议，欢迎在 Issues 中提出 如果你也喜欢本软件的设计思想，欢迎提交 Pr，非常感谢你对我们的支持！

贡献指南

贡献准则

如果您对本项目感兴趣，我们非常欢迎参与到项目的贡献中，我们会尽可能地提供帮助

在贡献前，我们希望您能与开发者进行沟通，以避免代码冲突

再次感谢您对项目的贡献！🎉