瀏覽代碼

feat: 更新 README

qinlaiqiao 3 年之前
父節點
當前提交
31332bf153
共有 2 個文件被更改,包括 16 次插入6 次删除
  1. 1 0
      .gitignore
  2. 15 6
      readme.md

+ 1 - 0
.gitignore

@@ -5,3 +5,4 @@ dist-ssr
 *.local
 build
 .idea
+.vscode

+ 15 - 6
readme.md

@@ -15,11 +15,16 @@
 ├── midway.config.ts // Midway 配置文件
 ├── src
 │   ├── apis // 后端目录
-│   │   ├── configuration.ts // Midway Hooks configuration
-│   │   └── lambda // Api 目录
-│   │       ├── index.test.ts // Api 测试文件
-│   │       └── index.ts // Api 文件
-│   └── main.ts // 前端框架入口文件
+│   │   ├── configuration.ts // Midway Hooks 配置文件
+│   │   ├── controller // Api 目录
+│   │   │   ├── index.test.ts // Api 测试文件
+│   │   │   └── index.ts // Api 文件
+│   │   ├── dto // 请求参数验证目录
+│   │   ├── middleware // 中间件目录
+│   │   ├── model // 数据库模型目录
+│   │   └── service // service目录
+│   ├── main.ts // 前端框架入口文件
+│   └── ... // 剩下的都是前端相关文件
 ├── tsconfig.json
 └── vite.config.ts
 ```
@@ -62,10 +67,12 @@ utils 目录用于存放相关工具方法,并拆分为了 3 个子目录:
 
 #### CSS
 
-本项目使用 scss。
+本项目使用 scss + tailwindcss
 
 本打算使用原生 css 变量 + PostCSS ,这也是 Vite 推荐的方式。但是考虑到大家的学习成本和项目进度,依然选择了熟悉的 scss。
 
+在使用 tailwindcss 的时候,为了保持 html 精简,建议在 `<style>` 标签内使用 `@apply` 命令加载 tailwindcss 的 class 类。
+
 #### 别名
 
 1. @ : src
@@ -74,6 +81,8 @@ utils 目录用于存放相关工具方法,并拆分为了 3 个子目录:
 
 3. service : src/apis/service
 
+4. utils : src/utils
+
 ### 相关命令
 
 #### 开发 server