diff --git a/docs/favicon.png b/docs/assets/favicon.png similarity index 100% rename from docs/favicon.png rename to docs/assets/favicon.png diff --git a/docs/assets/imgs/fe-auth.png b/docs/assets/imgs/fe-auth.png new file mode 100644 index 0000000..a48d9d2 Binary files /dev/null and b/docs/assets/imgs/fe-auth.png differ diff --git "a/docs/\345\274\200\345\217\221\346\226\207\346\241\243/index.md" "b/docs/\345\274\200\345\217\221\346\226\207\346\241\243/index.md" index 7baaf1a..85b02bc 100644 --- "a/docs/\345\274\200\345\217\221\346\226\207\346\241\243/index.md" +++ "b/docs/\345\274\200\345\217\221\346\226\207\346\241\243/index.md" @@ -47,8 +47,35 @@ ### 后端 1. 使用主体框架 `SpringBoot-Kotlin 3.2.5 Maven` - 1. SDK配置 - 2. 架构打包 + 1. SDK配置 + - [5.1.1] [redis.clients: jedis](https://mvnrepository.com/artifact/redis.clients/jedis/5.1.1) + - [2.10.1] [com.google.code.gson: gson](https://mvnrepository.com/artifact/com.google.code.gson/gson/2.10.1) + - [5.2.5] [org.apache.poi: poi](https://mvnrepository.com/artifact/org.apache.poi/poi/5.2.5) + - [5.2.5] [org.apache.poi: poi-ooxml](https://mvnrepository.com/artifact/org.apache.poi/poi-ooxml/5.2.5) + - [4.5.14] [org.apache.httpcomponents: httpclient](https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient/4.5.14) + - [3.5.6] [com.baomidou: mybatis-plus-spring-boot3-starter](https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-spring-boot3-starter/3.5.6) + - [3.5.16] [org.mybatis: mybatis](https://mvnrepository.com/artifact/org.mybatis/mybatis/3.5.16) + - [latest] [org.springframework.boot: spring-boot-starter-data-redis](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-data-redis) + - [latest] [org.springframework.boot: spring-boot-starter-jdbc](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-jdbc) + - [latest] [org.springframework.boot: spring-boot-starter-security](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-security) + - [latest] [org.springframework.boot: spring-boot-starter-thymeleaf](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-thymeleaf) + - [latest] [org.springframework.boot: spring-boot-starter-validation](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation) + - [latest] [org.springframework.boot: spring-boot-starter-web](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web) + - [latest] [org.springframework.boot: spring-boot-starter-mail](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-mail) + - [latest] [org.springframework.boot: spring-boot-starter-aop](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-aop) + - [latest] [org.thymeleaf.extras: thymeleaf-extras-springsecurity6](https://mvnrepository.com/artifact/org.thymeleaf.extras/thymeleaf-extras-springsecurity6) + - [latest] [org.postgresql: postgresql](https://mvnrepository.com/artifact/org.postgresql/postgresql) + - [latest] [org.projectlombok: lombok](https://mvnrepository.com/artifact/org.projectlombok/lombok) + - [latest] [org.springframework.boot: spring-boot-starter-test](https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-test) + - [latest] [org.springframework.security: spring-security-test](https://mvnrepository.com/artifact/org.springframework.security/spring-security-test) + - [latest] [eu.bitwalker: UserAgentUtils](https://mvnrepository.com/artifact/eu.bitwalker/UserAgentUtils) + - [latest] [com.fasterxml.jackson.module: jackson-module-kotlin](https://mvnrepository.com/artifact/com.fasterxml.jackson.module/jackson-module-kotlin) + - [latest] [org.jetbrains.kotlin: kotlin-reflect](https://mvnrepository.com/artifact/org.jetbrains.kotlin/kotlin-reflect) + - [latest] [org.jetbrains.kotlin: kotlin-stdlib](https://mvnrepository.com/artifact/org.jetbrains.kotlin/kotlin-stdlib) + 2. 架构打包 + - [dev] 开发架构 + - [test] 测试架构 + - [pord] 部署架构 2. 数据库采用 `PostgreSQL alpine3.19` 具体数据库设计逻辑见后 3. 缓存数据库采用 `Redis 7.2` 具体数据库样式逻辑见后 diff --git "a/docs/\346\246\202\350\246\201\346\226\207\346\241\243/\350\275\257\344\273\266\350\256\276\350\256\241\346\217\217\350\277\260\350\257\264\346\230\216\344\271\246(SDD).md" "b/docs/\346\246\202\350\246\201\346\226\207\346\241\243/\350\275\257\344\273\266\350\256\276\350\256\241\346\217\217\350\277\260\350\257\264\346\230\216\344\271\246(SDD).md" index 8e42e4c..8e90566 100644 --- "a/docs/\346\246\202\350\246\201\346\226\207\346\241\243/\350\275\257\344\273\266\350\256\276\350\256\241\346\217\217\350\277\260\350\257\264\346\230\216\344\271\246(SDD).md" +++ "b/docs/\346\246\202\350\246\201\346\226\207\346\241\243/\350\275\257\344\273\266\350\256\276\350\256\241\346\217\217\350\277\260\350\257\264\346\230\216\344\271\246(SDD).md" @@ -14,7 +14,7 @@ - **OCR**: 光学字符识别 ### 1.4 参考资料 -- [软件需求规格说明书（SRS）](软件需求规格说明书%20(SRS).md) +- [软件需求规格说明书（SRS）](软件需求规格说明书(SRS).md) - [项目计划说明书](项目计划说明书.md) - [相关标准和规范说明书](标准规格说明书.md) @@ -70,7 +70,7 @@ #### 3.2.1 数据库设计 - 描述数据库模式，包括ER图、表结构、索引策略、关系完整性约束等。 -> 请参考 [设计文档-数据库设计文档](/设计文档/数据库设计文档) +> 请参考 [设计文档-数据库设计文档](../设计文档/数据库设计文档.md) #### 3.2.2 数据流设计 - 描述数据流向和处理的方式，可以使用数据流图来辅助说明。 diff --git "a/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\216\210\346\235\203\350\256\276\350\256\241\346\226\207\346\241\243.md" "b/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\216\210\346\235\203\350\256\276\350\256\241\346\226\207\346\241\243.md" new file mode 100644 index 0000000..145e281 --- /dev/null +++ "b/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\216\210\346\235\203\350\256\276\350\256\241\346\226\207\346\241\243.md" @@ -0,0 +1,14 @@ +# 授权设计文档 + +> 授权设计文档是用作用户认证相关的设计文档 + +## 设计图 + +![](../assets/imgs/fe-auth.png) + +## 描述 + +- OTP 模式为令牌登录模式，即使用例如 `Google Authenticator`, `Microsoft Authenticator` 等令牌平台使用。 +- 普通登录模式分为密码登录、手机号登录、与邮箱验证登录 + - 其中密码登录、邮箱登录时若设置了 OTP 登录则需要经过令牌验证，否则略过 + - 其中采用手机号验证则登录成功可忽略令牌验证 diff --git "a/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\235\203\351\231\220\350\256\276\350\256\241\346\226\207\346\241\243.md" "b/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\235\203\351\231\220\350\256\276\350\256\241\346\226\207\346\241\243.md" new file mode 100644 index 0000000..700fee4 --- /dev/null +++ "b/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\235\203\351\231\220\350\256\276\350\256\241\346\226\207\346\241\243.md" @@ -0,0 +1 @@ +# 权限设计文档 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 75166de..8577612 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,28 +4,25 @@ repo_url: https://github.com/fantastic-editor/DevelopDoc repo_name: FantasticEditor/DevelopDoc copyright: Copyright © 2023 - 2024 锋楪 All Rights Reserved. 版权所有 theme: - logo: favicon.png - favicon: favicon.png + logo: assets/favicon.png + favicon: assets/favicon.png name: material language: zh palette: - media: "(prefers-color-scheme)" - primary: green - accent: cyan toggle: icon: material/brightness-auto name: 切换亮色模式 - media: "(prefers-color-scheme: light)" - scheme: default - primary: teal - accent: cyan + primary: blue + accent: indigo toggle: icon: material/brightness-7 name: 切换暗色模式 - media: "(prefers-color-scheme: dark)" scheme: slate - primary: teal - accent: cyan + primary: blue grey + accent: indigo toggle: icon: material/brightness-4 name: 依照系统进行模式切换 @@ -33,8 +30,12 @@ theme: - search.suggest - search.highlight - navigation.instant + - navigation.instant.prefetch - navigation.instant.progress - navigation.tabs - navigation.footer + - toc.follow + - toc.integrate + - navigation.top plugins: - search \ No newline at end of file