欢迎来到本项目的贡献指南!我们非常感谢您对本项目的兴趣和支持。无论您是想报告错误、提出新功能建议,还是提交代码贡献,我们都欢迎您的参与。
为了更好的帮助您了解如何贡献本项目,请参考以下内容:
本项目采用类似微服务架构的设计理念,旨在提供高效、可扩展的解决方案。为了更好的管理和开发,本项目采用了 Monorepo(单一代码库)结构,所有相关服务和组件都集中在一个代码库中进行维护。
其他非 web 平台的衍生项目请查看对应项目的仓库文档。
下面是本项目的主要目录结构及其简要说明:
/
├── apps/
│ ├── api/ # API 服务,基于 Fastify 框架开发,负责处理客户端请求和业务逻辑。
│ ├── cloudflare/ # Cloudflare Workers 项目,用于海外检测等辅助能力。
│ ├── deployer/ # Deployer 服务,使用 Go 编写,负责接收 Webhook 与部署触发。
│ ├── status/ # 状态监控服务,基于 Fastify 开发,提供系统状态监控、维护提示和解析管理功能。
│ ├── web/ # 前端应用,使用 Astro 框架,组件层采用 Svelte + Web Components。
│ └── worker/ # Worker 服务,使用 Go 语言编写,负责后台任务处理和调度。
├── packages/
│ ├── db/ # Drizzle ORM schemas
│ ├── configs/ # 共享配置
│ └── utils/ # 通用工具
├── infra/ # 基础设施相关代码
│ ├── docker/ # Docker 配置和相关文件
│ ├── nginx/ # Nginx 配置
│ └── scripts/ # 部署和维护脚本
└── ......
请选择您擅长的领域进行贡献,无论是前端、后端还是基础设施,我们都非常欢迎您的参与!