Aaveg 应用

Aaveg Fest Flutter 应用

截图

 
 
 
 
 
 
 
 
 

Flutter

要求

  • Java版本 – ‘12.x’
  • Flutter版本 – ‘2.5.x’
  • Dart版本 – ‘2.12’ 或更高版本
  • Android Studio

设置

  • Fork 并克隆仓库
    git clone <YOUR_FORK_URL>
  • 添加远程上游
    git remote add upstream <MAIN_REPO_URL>
  • 获取 pubspec 中列出的所有依赖项
    flutter pub get
  • 运行应用
    flutter run

Firebase

要求

设置

  • 将 google-services.json 文件添加到 android/app/ 目录下

  • 将文件路径添加到 .gitignore（如果尚未添加）

  • 创建 tar 文件 [services.tar]，在您项目的根目录下运行以下命令来创建存档文件

    tar cvf services.tar android/app/google-services.json

  • 将 services.tar 添加到 .gitignore（如果尚未添加）

  • 运行以下命令来加密 services.tar 文件。

    gpg -c services.tar

  • 加密过程中，它会要求输入密码，该密码将用于解密加密文件。运行命令后，您的项目根目录下将出现一个名为 services.tar.gpg 的新文件。

  • 将 gpg 密码添加到 GitHub 密钥中

GitHub Actions

工作流

  • on: [pull_request, push] to main: 当有人向 main 分支推送或发起拉取请求时，此工作流将触发。
  • 在步骤中，我们正在
    • 如果 pull_request
      • 运行格式化程序
      • 运行分析器
    • 如果 push
      • 使用存储在 FIREBASE_SECRET 中的密码解密 services.tar.gpg。
      • 构建 app-release.apk。
      • 将生成的 app-release.apk 存储在工件中

Git Hooks

配置 Git Hooks 路径

  • 运行以下命令
    git config core.hooksPath .githooks

功能

  • pre-commit

    • 运行格式化程序
    • 运行分析器

  • pre-push

    • 检查未提交的文件
    • 运行测试用例

为 Aaveg 应用贡献

我们希望您遵循以下指南

注意

切勿直接推送到主仓库（upstream）。仅推送到您的 fork 仓库（origin），然后向
主仓库发起拉取请求

编码规则

为了确保整个源代码的一致性，在工作时请牢记这些规则

  • 要遵循的编码风格以及使用 flutter_lint 的说明
  • 启用 Sound-Null-Safety

Git 提交指南

提交消息格式

每条提交消息都包含一个标题、一个正文和一个页脚。标题有一个特殊的
格式，包括一个类型、一个范围和一个主题

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

提交消息的任何行长度都不能超过 100 个字符！这使得消息更容易在 GitHub
以及各种 Git 工具中阅读。

示例提交消息

feat(Profile): display QR code

fetch the qr code from API and display it on Profile page (profile_screen.dart)

fixes #1234

请遵循此处 的约定。

此外，请参考 此页面了解如何编写正文

GitHub

查看 Github