英语 | 葡萄牙语

Memo

Memo Icon


Release

Memo 的单仓库。

Memo 是一个开源的、编程导向的 间隔重复
软件 (SRS),使用 Flutter 编写。

目前,该项目仅设计为输出 Android 和 iOS 的构建。尽管如此,考虑到当前
稳定性的 Flutter SDK 对于桌面 (Windows、Linux 和 macOS) 和 Web,很有可能该
项目最终将支持所有平台的构建。


此 README 旨在指导该项目的结构,并应作为指导,以帮助项目随着
当前和未来的需求进行扩展。将其视为指导项目决策的灵活规则集。虽然
它们可以(并且可能)会随着时间的推移而改变,但必须提出讨论来触发这些改变:这意味着
在采取任何破坏此处做出的任何理性决策的操作之前,我们将思考/质疑自己。它也
有效地指导 PR 讨论。

  • 设置:如何配置您的本地项目;
  • 架构:此应用程序从内部如何工作;
  • 背景:关于该项目的一些背景故事;
  • 贡献和良好实践:关于如何为该
    应用程序编写良好代码的建议;
  • 许可:此软件的许可方式以及您可以使用它的方式。

设置

如果您不知道如何安装 Flutter 并本地运行它,请查看此
开始.

如果您已在本地设置 Flutter,请在项目的根文件夹中,通过运行安装 pubspec 依赖项
flutter pub get.

Firebase 依赖项

Memo 具有需要在本地运行之前设置的 Firebase 依赖项。更多信息请参见
ARCHITECTURE#firebase.

架构

此应用程序从内部如何工作以及如何与外部依赖项交互——在
ARCHITECTURE.md 中详细介绍.

背景

如果您有兴趣查看我们如何处理该项目的软件流程(在我们的
团队内部),请查看 .process/(目前仅为 ptBR)。

贡献和良好实践

有关如何为该项目贡献的详细信息,请参阅 CONTRIBUTING

许可证

Memo 在 BSD 3-Clause 下发布。

赞助商

该项目是在以下赞助商的帮助下构建的

GitHub

https://github.com/olmps/memo