docs: front-end and back-end readme.md

packages/toolkits/pro/template/server/nestJs/README.md

@@ -1,26 +1,58 @@
-### Sequelize sample
+# TinyPro Nest.js
 
-### Installation
+## 说明
 
-`npm install`
+此项目为 tiny-toolkit-pro 套件初始化的 TinyPro 的 Nest.js 后端项目。
 
-### Running
+## 快速上手
 
-This example requires docker or a local MySQL installation.  If using a local MySQL database, see `app.module.ts` for credentials, and make sure there are matching credentials in the database and the source code.
+### 依赖安装
 
-#### Docker
+您可以选择任何您喜欢的包管理工具, 这里使用了 npm
 
-There is a `docker-compose.yml` file for starting Docker.
+```
+npm install
+```
 
-`docker-compose up`
+### 开发环境启动
 
-After running the sample, you can stop the Docker container with
+在启动开发环境时, 请确保本机已经启动了 `MySQL` 与 `Redis` 服务。并已经做好了如下检查
 
-`docker-compose down`
+1. 启动了 `MySQL` 服务
+2. `MySQL` 服务可以访问
+3. 启动了 `Redis` 服务
+4. `Redis` 服务可以正常访问
+5. `.env`文件中 `DATABASE_HOST` 配置项是 `MySQL` 服务的 IP 地址
+6. `.env`文件中 `DATABASE_PORT` 配置项是 `MySQL` 服务的端口号
+7. `.env`文件中 `DATABASE_NAME` 配置项指明的数据库存在
+8. `.env`文件中 `DATABASE_SYNCHRONIZE` 为 `true`
+9. `.env`文件中 `DATABASE_USERNAME` 指明的用户存在且拥有对 `DATABASE_NAME` 配置项指明的数据库有增加、删除、修改、查询权限
+10. `.env`文件中 `DATABASE_AUTOLOADENTITIES` 为 `true`
+11. `.env`文件中 `REDIS_HOST` 为 `Redis` 服务 IP
+12. `.env`文件中 `REDIS_PORT` 为 `Redis` 服务端口号
+13. 依赖安装完成
 
-### Run the sample
+### Docker启动
 
-Then, run Nest as usual:
+在使用 docker 环境时, 您应当确保机器已经安装了 Docker 服务. 本章仅阐述项目默认的 `docker-compose.yaml` 文件的启动注意事项
 
-`npm run start`
+1. 您的 `docker` 服务安装成功
+2. `.env` 文件中 `DATABASE_PASSWORD` 与 `services.mysql.environment.MYSQL_ROOT_PASSWORD` 是一致的 (如果 `.env` 文件中 `DATABASE_USERNAME` **不为** root 可以忽略此检查)
+2. `.env` 文件中 `DATABASE_PASSWORD` 与 `services.mysql.environment.MYSQL_PASSWORD` 是一致的 (如果 `.env` 文件中 `DATABASE_USERNAME` 为 root 可以忽略此检查)
+3. `.env` 文件中 `DATABASE_USERNAME` 与 `services.mysql.environment.MYSQL_USER` 是一致的 (如果 `.env` 文件中 `DATABASE_USERNAME` 为 root 可以忽略此检查)
+4. `services.mysql.environment.MYSQL_DATABASE` 与 `.env` 文件中 `DATABASE_NAME` 是一致的
+5. `.env`文件中 `DATABASE_SYNCHRONIZE` 为 `true`
+6. `.env`文件中 `DATABASE_HOST` 为 `mysql`
+7. `.env`文件中 `REDIS_HOST` 为 `redis`
 
+完成上述检查后, 您可以使用 `docker compose up -d` 来运行 docker 环境
+
+
+## 二次开发指南
+
+// WAITING FOR DOCUMENT DEPLOY
+// SHOULD LINK TO tiny-pro-backend-dev-guideline.md
+
+## 遇到困难?
+
+加官方小助手微信 opentiny-official，加入技术交流群

packages/toolkits/pro/template/tinyvue/README.md

@@ -1,7 +1,60 @@
 # TinyPro of vue
+
 ## 说明
-
-此项目为tiny-toolkit-pro 套件初始化的以 TinyPro of vue 为模板的一个Vue项目
-
-## 用法
-npm run start
+
+此项目为 tiny-toolkit-pro 套件初始化的 TinyPro 的 Vue 项目。
+
+## 快速上手
+
+### 依赖安装
+
+请选择任何一个你喜欢的包管理工具进行安装, 这里使用的`npm`
+
+```
+npm i
+```
+### 启动开发环境
+
+```
+npm run dev
+```
+
+### 启动mock服务
+
+部分场景使用了mock数据, 所以请确保您启动了mock服务
+
+```
+npm run mock
+```
+
+## 目录结构
+
+```
+config              # 打包工具配置文件
+public
+src
+  api               # Api 管理
+  assets            # 静态资源
+  components        # 公用组件
+  config            # HWC 配置文件
+  directive         # 指令
+  hooks             # 可组合函数 https://cn.vuejs.org/guide/reusability/composables
+  layout            # 布局组件
+  locale            # 本地国际化词条 (例如登录页)
+  mock              # mock服务
+  router            # 路由
+  store             # 全局状态
+  types             # 通用类型
+  utils             # 通用工具
+  views             # 页面
+    ...
+```
+
+## 二次开发指南
+
+// WAITING FOR DOCUMENT DEPLOY
+// SHOULD LINK TO tiny-pro-front-dev-guideline.md
+
+## 遇到困难?
+
+加官方小助手微信 opentiny-official，加入技术交流群