[pull] master from RealKai42:master

.vscode/settings.json

@@ -45,5 +45,7 @@
   },
   "[json]": {
     "editor.defaultFormatter": "vscode.json-language-features"
-  }
+  },
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true
 }

Dockerfile

@@ -1,14 +1,11 @@
-FROM node:18 AS build
+FROM node:20 AS build
 
 # 设置工作目录
 WORKDIR /app
 
-COPY package*.json ./
-
-RUN npm install
-
 COPY . .
-
+RUN npm config set registry  https://registry.npmmirror.com  
+RUN npm install
 RUN npm run build
 
 # 将构建好的 React 应用复制到 Nginx 容器的默认站点目录

README.md

@@ -8,16 +8,23 @@
 
 <p align="center">
   <a href="./docs/README_EN.md">English</a>
+  <a href="./docs/README_JP.md">日本語</a>
 </p>
 
 <p align="center">
   为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件
 </p>
 
-<p align="center">
+<p align="center" style="display: flex; justify-content: center; gap: 10px;">
   <a href="https://github.com/Realkai42/qwerty-learner/blob/master/LICENSE"><img src="https://img.shields.io/github/license/Realkai42/qwerty-learner" alt="License"></a>
   <a><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"/></a>
   <a><img src="https://img.shields.io/badge/Powered%20by-React-blue"/></a>
+  <a><img src="https://img.shields.io/github/stars/RealKai42/qwerty-learner"/></a>
+  <a><img src="https://img.shields.io/github/forks/RealKai42/qwerty-learner"/></a>
+  <a href="https://gitcode.com/RealKai42/qwerty-learner/overview"><img src="https://gitcode.com/RealKai42/qwerty-learner/star/badge.svg"/></a>
+    <a href="https://api.gitsponsors.com/api/badge/link?p=4DNHTkFshpqUNxrflL7n6ChVhCijBEN9zvnj50mFETUw2frmOXfrHW37m71uOnlp+eo/Vm8a0w94m0JeT4UAYxOAQwzuFiJS0UYIQ8H3km39ZcUnZ7wHNE05WpqBzTVcgZM26FijLiYv9m2p7mxx1w==">
+    <img src="https://api.gitsponsors.com/api/badge/img?id=331603334" height="20" alt="GitSponsors">
+  </a>
 </p>
 
 <div align=center>
@@ -26,11 +33,12 @@
 
 ## 📸 在线访问
 
-Vercel: <https://qwerty.kaiyi.cool/> , <https://qwerty-learner.vercel.app/>
+**首选部署**: <https://qwerty.kaiyi.cool/>
 GitHub Pages: <https://realkai42.github.io/qwerty-learner/>
-Gitee Pages: <https://kaiyiwing.gitee.io/qwerty-learner/>
 
-国内用户建议使用 Gitee 访问
+镜像仓库:
+[GitCode: RealKai42/qwerty-learner](https://gitcode.com/RealKai42/qwerty-learner/overview)
+[Gitee: KaiyiWing/qwerty-learner](https://gitee.com/KaiyiWing/qwerty-learner)
 <br/>
 <br/>
 
@@ -127,13 +135,40 @@ Gitee Pages: <https://kaiyiwing.gitee.io/qwerty-learner/>
 
 本项目是基于`React`开发的，需要 node 环境来运行。
 
+### 环境准备
+
+1. NodeJS
+2. Git
+3. Yarn
+
+> **验证是否已经拥有相关环境**
+>
+> 1. 手动验证  
+>    请在命令行下执行以下命令，查看是否有对应版本输出
+>
+>    ```sh
+>    node --version
+>    git --version
+>    yarn --version
+>    ```
+>
+> 2. 脚本验证  
+>    使用我们提供的脚本对所需环境进行验证，如果确实依赖项会自动安装
+>    - Windows 用户可以直接执行 [pre-check.ps1](scripts/pre-check.ps1) 脚本
+>    - MacOS 用户可以直接执行 [pre-check.sh](scripts/pre-check.sh) 脚本
+
+如果有对应环境缺失，我们可以参考下列官方文档进行安装
+
+> - [NodeJS](https://nodejs.org/en/download)
+> - [Git](https://git-scm.com/downloads)
+> - [yarn](https://classic.yarnpkg.com/lang/en/docs/install)
+
 ### 手动安装
 
-1. 安装 NodeJS，参考[官方文档](https://nodejs.org/en/download)
-2. 使用 `git clone` 下载项目到本地, 不使用 git 可能因为缺少依赖而无法运行
-3. 打开命令行，在项目根目录下，运行`yarn install`来下载依赖。
-4. 执行`yarn start`来启动项目，项目默认地址为`http://localhost:5173/`
-5. 在浏览器中打开`http://localhost:5173/`来访问项目。
+1. 在命令行中执行 `git clone https://github.com/RealKai42/qwerty-learner.git` 将项目拉取到本地, 如果不使用 git 可能因为缺少依赖而无法运行
+2. 在命令行中执行 `cd qwerty-learner`，进入项目根目录，执行`yarn install`来下载依赖。
+3. 执行`yarn start`来启动项目，项目默认地址为`http://localhost:5173/`
+4. 在浏览器中打开`http://localhost:5173/`来访问项目。
 
 ### 脚本执行
 
@@ -160,7 +195,8 @@ Gitee Pages: <https://kaiyiwing.gitee.io/qwerty-learner/>
 - V2EX 全站热搜项目
 - Gitee 全站推荐项目
 - [少数派首页推荐](https://sspai.com/post/67535)
-- Gitee 最有价值开源项目([GVP](https://gitee.com/gvp))
+- GitCode 开源摘星计划-毕业项目（[G-Star 计划](https://gitcode.com/g-star)）
+- Gitee 最有价值开源项目（[GVP](https://gitee.com/gvp)）
 
 ## 📕 词库列表
 
@@ -182,6 +218,7 @@ Gitee Pages: <https://kaiyiwing.gitee.io/qwerty-learner/>
 - 人教版英语 3-9 年级
 - 王陆雅思王听力语料库 [@Saigyouji_WKKun](https://github.com/ggehuliang)
 - 日语常见词、N1 ～ N5 [@xiaojia](https://github.com/wetery)
+- 哈萨克语基础 3000 词(哈拼版) 来源于 [@Elgar](https://github.com/Elgar17) 由 [@Herbert He](https://github.com/HerbertHe) 通过 [哈拼](https://ha-pin.js.org) 技术支持
 
 如果您需要背诵其他词库，欢迎在 Issue 中提出
 

docker-compose.yaml

@@ -2,28 +2,8 @@ version: '3'
 
 services:
   qwertylearner:
-    image: 'node:16'
-    user: 'root'
-    working_dir: '/app/qwerty-learner'
-    ports: [8990:5173]
-    volumes:
-      - $PWD/:/app/qwerty-learner
-    command:
-      - /bin/sh
-      - -c
-      - |
-        echo 'run the bash command..'
-        npm -v
-        npm config set registry https://registry.npm.taobao.org
-        npm install -g yarn
-        cd /app/qwerty-learner
-        yarn install
-        yarn build
-        nohup yarn start --host=0.0.0.0 &
-        echo 'success.. start..'
-        pwd
-        echo '查看输出:...'
-        cat nohup.out
-        tail -f /dev/null
-    tty: true
-    stdin_open: true
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - '8990:5173'