Paopao-CE 开源项目教程
1. 项目的目录结构及介绍
Paopao-CE 是一个基于 Gin、Zinc、Vue 和 TypeScript 构建的艺术性“类 Twitter”社区。项目的目录结构如下:
paopao-ce/
├── config/
│ ├── config.yaml
│ └── config.yaml.sample
├── custom/
│ └── config.yaml
├── docs/
│ ├── deploy/
│ ├── discuss/
│ ├── openapi/
│ └── proposal/
├── Makefile
├── README.md
└── ...
config/
:包含项目的配置文件,如config.yaml
和config.yaml.sample
。custom/
:用于存放自定义配置文件。docs/
:包含各种开发文档,如部署文档、问题交流论述文档、后端导出API文档和功能特性提案文档。Makefile
:用于构建和运行项目的 Makefile 文件。README.md
:项目的主文档,包含项目的基本信息和使用说明。
2. 项目的启动文件介绍
Paopao-CE 的启动文件是 paopao-ce
,它负责启动整个应用程序。启动时会读取 /custom/config.yaml
或 /config/config.yaml
配置文件(优先读取最先找到的文件)。
启动命令如下:
paopao serve
3. 项目的配置文件介绍
Paopao-CE 的配置文件是 config.yaml
,它包含了项目的各种配置选项。以下是配置文件的主要内容:
Features:
Default: ["Base", "MySQL", "Option", "LocalOSS", "LoggerFile"]
Develop: ["Base", "MySQL", "Option", "Sms", "AliOSS", "LoggerZinc"]
Demo: ["Base", "MySQL", "Option", "Sms", "MinIO", "LoggerZinc"]
Slim: ["Base", "Sqlite3", "LocalOSS", "LoggerFile"]
Base: ["Zinc", "Redis", "Alipay"]
Option: ["SimpleCacheIndex"]
Sms: "SmsJuhe"
Default
、Develop
、Demo
、Slim
:不同的功能集套件。Base
、Option
:子功能套件。Sms
:关于短信验证码功能的参数选项。
例如,Default
套件代表的意思是:使用 Base
和 Option
中的功能,外加 MySQL
、LocalOSS
和 LoggerFile
功能。
配置文件的示例可以在 config.yaml.sample
中找到。