Stripe Firebase 扩展项目教程

Stripe Firebase 扩展项目教程

stripe-firebase-extensionsRepository of Firebase Extensions built by Stripe.项目地址:https://gitcode.com/gh_mirrors/st/stripe-firebase-extensions

1. 项目的目录结构及介绍

stripe-firebase-extensions/
├── firestore-stripe-invoices/
├── firestore-stripe-payments/
├── firestore-stripe-subscriptions/
├── firestore-stripe-web-sdk/
├── .gitignore
├── .prettierignore
├── .prettierrc.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── lerna.json
├── package.json
└── run-cloudflared.sh

目录结构介绍

• firestore-stripe-invoices/: 包含用于发送发票的 Stripe 扩展的源代码。
• firestore-stripe-payments/: 包含用于处理支付的 Stripe 扩展的源代码。
• firestore-stripe-subscriptions/: 包含用于处理订阅的 Stripe 扩展的源代码。
• firestore-stripe-web-sdk/: 包含用于 Web SDK 的 Stripe 扩展的源代码。
• .gitignore: Git 忽略文件，指定哪些文件和目录不应被 Git 跟踪。
• .prettierignore: Prettier 忽略文件，指定哪些文件和目录不应被 Prettier 格式化。
• .prettierrc.yaml: Prettier 配置文件，定义代码格式化的规则。
• CODE_OF_CONDUCT.md: 行为准则文件，定义项目参与者的行为规范。
• CONTRIBUTING.md: 贡献指南文件，指导开发者如何为项目做出贡献。
• LICENSE: 许可证文件，定义项目的开源许可证。
• README.md: 项目说明文件，提供项目的概述和使用说明。
• lerna.json: Lerna 配置文件，用于管理多包存储库。
• package.json: Node.js 项目的配置文件，定义项目的依赖和脚本。
• run-cloudflared.sh: 运行 Cloudflare 的脚本文件。

2. 项目的启动文件介绍

项目的启动文件主要集中在各个扩展目录中，例如 firestore-stripe-payments/ 目录下的 index.js 或 main.js 文件。这些文件通常是扩展的入口点，负责初始化扩展并处理与 Firebase 和 Stripe 的集成。

示例启动文件

// firestore-stripe-payments/index.js
const functions = require('firebase-functions');
const stripe = require('stripe')(functions.config().stripe.secret_key);

exports.createPaymentIntent = functions.firestore
  .document('payments/{paymentId}')
  .onCreate(async (snap, context) => {
    const payment = snap.data();
    const paymentIntent = await stripe.paymentIntents.create({
      amount: payment.amount,
      currency: payment.currency,
    });
    return snap.ref.set({ paymentIntentId: paymentIntent.id }, { merge: true });
  });

启动文件功能

• 初始化 Firebase 函数: 使用 firebase-functions 模块初始化 Firebase 云函数。
• 配置 Stripe: 使用 stripe 模块配置 Stripe，并使用 Firebase 配置中的密钥。
• 处理支付: 创建支付意图并将其存储在 Firestore 中。

3. 项目的配置文件介绍

package.json

package.json 文件是 Node.js 项目的配置文件，定义了项目的依赖、脚本和其他元数据。

{
  "name": "stripe-firebase-extensions",
  "version": "1.0.0",
  "description": "Firebase Extensions for Stripe",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Invertase",
  "license": "Apache-2.0",
  "dependencies": {
    "firebase-functions": "^3.14.1",
    "stripe": "^8.153.0"
  }
}

配置文件功能

• 项目名称和版本: 定义项目的名称和版本号。
• 主入口文件: 指定项目的主入口文件。
• 脚本: 定义项目的脚本，例如测试脚本。
• 依赖: 列出项目所需的依赖包及其版本。

.prettierrc.yaml

.prettierrc.yaml 文件是 Prettier 的配置文件，定义了代码格式化的规则。

printWidth: 80
tabWidth: 2
useTabs: false
semi: true
singleQuote: true
trailingComma: 'es5'
bracketSpacing: true
arrowParens: 'always'

配置文件功能

• 打印宽度: 定义每行的最大字符数。
• 缩进宽度: 定义缩进的空格数。
• 使用制表符: 定义是否使用制表符进行缩进。
• 分号: 定义是否在语句末尾添加分号。
• 单引号: 定义是否使用单引号。
• 尾随逗号: 定义是否在多行对象和数组中添加尾随逗号。
• 括号间距: 定义是否在对象和数组的括号内添加空格。
• 箭头函数参数: 定义是否在箭头函数中使用括号包裹参数。

通过以上内容，您可以了解 stripe-firebase-extensions 项目的目录结构、启动文件和配置文件的基本信息。

stripe-firebase-extensionsRepository of Firebase Extensions built by Stripe.项目地址:https://gitcode.com/gh_mirrors/st/stripe-firebase-extensions