ClearFlask 项目使用教程

1. 项目目录结构及介绍

ClearFlask 项目是一个开源的反馈管理工具，旨在帮助用户在产品开发过程中收集和管理用户反馈。以下是项目的目录结构及各部分的作用：

• clearflask-api: 包含 API 相关的代码。
• clearflask-frontend: 包含前端代码，用于构建用户界面。
• clearflask-i18n: 国际化支持代码。
• clearflask-legal: 法律相关的文档和代码。
• clearflask-logging: 日志记录相关的代码。
• clearflask-release: 发布相关的文件和脚本。
• clearflask-resources: 资源文件，如图片、样式表等。
• clearflask-server: 服务器端代码，用于处理请求。
• tools: 包含开发工具和脚本。
• .github: 包含 GitHub 相关的配置文件。
• .idea: IntelliJ IDEA 的项目配置文件。
• .vscode: Visual Studio Code 的项目配置文件。
• ARCHITECTURE.md: 项目的架构描述。
• BUILDING.md: 构建项目的指南。
• CONTRIBUTING.md: 贡献指南。
• COPYING: 项目许可证信息。
• INSTALLATION.md: 安装指南。
• Makefile: 用于构建项目的 Makefile 文件。
• README.md: 项目介绍和说明。
• RELEASE.md: 版本发布说明。
• SECURITY.md: 安全相关的信息。
• crowdin.yml: Crowdin 国际化工具的配置文件。
• demo-page-feedback.png: 示例页面的反馈图像。
• lombok.config: Lombok 配置文件。
• package-lock.json: Node.js 包锁定文件。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 Docker Compose 来进行。以下是一个简单的启动流程：

• 下载 Docker Compose 服务文件，通常为 docker-compose.yml。
• 在命令行中运行 docker-compose --profile with-deps up 命令来启动所有服务。
• 启动后，通过浏览器访问 http://localhost，使用默认的邮箱 admin@localhost 创建账户。

3. 项目的配置文件介绍

项目的配置文件主要用于设置服务器和前端的行为。以下是一些主要的配置文件及其作用：

• server/config-selfhost.cfg: 服务器端的自托管配置文件，包含数据库连接信息、邮件服务等设置。
• connect/connect.config.json: 前端的配置文件，包含域名设置、证书管理等配置。

在启动项目之前，需要仔细阅读并修改这些配置文件，以确保它们符合你的需求和环境设置。特别是邮件服务和域名设置，对于项目正常运行至关重要。