Formance Stack 开发者指南

Formance Stack 开发者指南

stack Modular developer platform to build and operate complex money flows of any size and shape 项目地址: https://gitcode.com/gh_mirrors/stack6/stack

1. 项目目录结构及介绍

Formance Stack 的目录结构如下所示：

.
├── .earthlyignore
├── .editorconfig
├── .envrc
├── .gitignore
├── CODEOWNERS
├── Earthfile
├── LICENSE
├── README.md
├── base.Dockerfile
├── codecov.yml
├── docker-compose.yml
├── go.mod
├── go.sum
├── libs
│   └── ...
├── releases
│   └── ...
├── tests
│   └── ...
└── ...

• .earthlyignore：定义了 Earthly build 的忽略文件列表。
• .editorconfig：配置编辑器的代码风格。
• .envrc：环境变量配置文件。
• .gitignore：定义了 Git 忽略的文件列表。
• CODEOWNERS：指定代码仓库中各部分的负责人。
• Earthfile：定义了 Earthly 的构建流程。
• LICENSE：项目的许可文件。
• README.md：项目的说明文档。
• base.Dockerfile：定义了基础 Docker 镜像的构建。
• codecov.yml：CodeCov 的配置文件。
• docker-compose.yml：定义了项目服务的 Docker Compose 配置。
• go.mod 和 go.sum：Go 项目的依赖管理文件。
• libs：包含项目使用的库。
• releases：存放项目发布版本。
• tests：包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来配置和启动。以下是启动文件的基本结构：

version: '3.8'
services:
  web:
    image: formancehq/web:latest
    ports:
      - "80:80"
  api:
    image: formancehq/api:latest
    ports:
      - "3000:3000"
  db:
    image: postgres:latest
    environment:
      POSTGRES_USER: ...
      POSTGRES_PASSWORD: ...
      POSTGRES_DB: ...

在这个文件中，我们定义了三个服务：web、api 和 db。web 服务用于提供 web 界面，api 服务提供 RESTful API，而 db 服务则用于数据库。

3. 项目的配置文件介绍

项目的配置主要通过环境变量和 Docker Compose 文件中的 environment 部分来完成。以下是配置文件的一个示例：

version: '3.8'
services:
  api:
    image: formancehq/api:latest
    environment:
      DATABASE_URL: "postgres://user:password@db:5432/dbname"
      API_KEY: "your_api_key_here"
    depends_on:
      - db

在这个配置中，我们设置了 DATABASE_URL 用于连接数据库，以及 API_KEY 作为 API 的密钥。这些环境变量可以在服务启动时通过 docker-compose 传递给容器。

stack Modular developer platform to build and operate complex money flows of any size and shape 项目地址: https://gitcode.com/gh_mirrors/stack6/stack