Skip to content

README.md

Latest commit

 

History

History
70 lines (49 loc) · 3.74 KB

README.md

File metadata and controls

70 lines (49 loc) · 3.74 KB
Raw

acits_flutter

acits.ru 的 Flutter 移动客户端——用于动物收容所内动物追踪的免费开源软件。

收容所工作人员和管理员可以实时维护他们所照顾动物的档案：医疗处方、日程安排、领养申请、文档和照片。该应用提供 dev 和 prod 两种构建风味，并通过自动生成的 OpenAPI 客户端与 ACITS 后端通信。

技术栈

flutter_bloc（Cubit）· go_router · easy_localization · get_it + injectable · Chopper/Dio（OpenAPI）· Firebase · Patrol 用于端到端测试。通过 FVM 固定使用 Flutter 3.44 / Dart 3.12。

快速开始

git clone https://github.com/aiserrock/acits-flutter.git
cd acits-flutter
fvm install && fvm flutter pub get
fvm dart run build_runner build --delete-conflicting-outputs
fvm flutter run -t test/dev/main.dart --flavor dev

Firebase 配置文件已被 gitignore——请先复制 *.example 模板（详见 CONTRIBUTING.md）。

构建

CI 在 pull request 上运行（lint、静态分析、测试、构建）——直接合并到 main/develop 不会触发任何流程，因为对应的 PR 早已跑完整个流水线。

推送 v* 标签（例如 v0.5.1）会构建 Android/iOS/web，发布带有 dev APK 附件的 GitHub Release，将 prod web 构建部署到 GitHub Pages，并将构建通知发送到 Telegram 上的 构建通知频道。

在线 PWA —— prod web 构建，可作为 Progressive Web App 安装。

文档

  • 贡献指南 —— 环境搭建、项目结构、本地化、测试、构建与 PR 工作流。
  • Wiki —— 架构说明、构建风味以及 CI 流水线细节。
  • 安全策略 —— 支持的版本以及如何报告漏洞。
  • 行为准则

社区

欢迎贡献代码——在提交 PR 之前请先阅读 CONTRIBUTING.md。

许可证

基于 MIT 许可证 发布。