Fireward 项目教程

Fireward 项目教程

fireward A concise and readable language for Firestore security rules, similar to Firebase Bolt. 项目地址: https://gitcode.com/gh_mirrors/fi/fireward

1. 项目介绍

Fireward 是一个用于编写 Firestore 安全规则的简洁且易读的语言。它类似于 Firebase Bolt，但提供了更多的功能和灵活性。Fireward 的主要目标是使 Firestore 安全规则的编写更加直观和易于维护，同时支持生成 TypeScript 接口。

Fireward 的特点包括：

• 快速编译
• 类型化的路由，转换为验证规则代码
• 元组验证
• 字面量类型
• 类型联合
• 自定义验证表达式
• 注释
• 强大的单元测试套件
• 端到端测试

2. 项目快速启动

安装 Fireward

方法 1: 使用 NPM 安装

npm install -g fireward

方法 2: 下载二进制文件

从 GitHub Releases 下载适用于你平台的二进制文件，并将其放入你的 PATH 中。

方法 3: 自行编译

1. 下载适用于你平台的 Haskell Stack 工具，并将其放入 PATH 中。
2. 进入项目目录并运行以下命令：

cd fireward
stack install

编译完成后，fireward 可执行文件将被放入 stack path --local-bin 指定的路径中。

使用 Fireward

生成 Firestore 规则

fireward -i myrules.ward > firestore.rules

生成 TypeScript 定义

fireward -i myrules.ward --lang=typescript > MyTypings.ts

3. 应用案例和最佳实践

案例 1: StretchMinder

StretchMinder 是一个 iOS 工作休息计时器，提醒用户在长时间坐着时进行短暂的引导运动和呼吸练习。该项目使用 Fireward 来结构化和保护其数据，并提供购物车项目预订系统。

案例 2: Oresman Readers Website

Oresman Readers Website 是一个展示 Donald 和 Patricia Oresman 著名艺术收藏的网站。它依赖 Fireward 来结构化和保护其数据，并提供购物车项目预订系统。

最佳实践

• 类型安全：使用 Fireward 的类型系统来确保数据的完整性和一致性。
• 权限控制：通过 Fireward 的规则语法来精确控制数据的读写权限。
• 单元测试：利用 Fireward 的单元测试套件来验证规则的正确性。

4. 典型生态项目

COGS

COGS 是一个直观的硬件/软件平台，用于创建现实世界的互动体验，如密室逃脱和沉浸式剧场。

Super Magic Link

Super Magic Link 允许 Twitch 主播将其视频游戏、电视节目、电影和音乐与观众同步。

其他项目

你可以在 Fireward 的 GitHub 仓库中提交你的项目，以便在社区中展示和分享。

fireward A concise and readable language for Firestore security rules, similar to Firebase Bolt. 项目地址: https://gitcode.com/gh_mirrors/fi/fireward