Sage 项目教程

Sage 项目教程

sage A dependency-free tool to run distributed transactions in Elixir, inspired by Sagas pattern. 项目地址: https://gitcode.com/gh_mirrors/sage/sage

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

Sage 项目的目录结构如下：

sage/
├── github/
│   └── workflows/
├── lib/
├── test/
├── formatter.exs
├── gitignore
├── LICENSE.md
├── README.md
├── coveralls.json
├── dialyzer-ignore-warnings
├── mix.exs
├── mix.lock

目录结构介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• lib/: 包含 Sage 项目的主要代码库。
• test/: 包含项目的测试代码。
• formatter.exs: 代码格式化配置文件。
• gitignore: Git 忽略文件配置。
• LICENSE.md: 项目许可证文件。
• README.md: 项目说明文档。
• coveralls.json: 代码覆盖率配置文件。
• dialyzer-ignore-warnings: Dialyzer 静态分析工具的忽略警告配置。
• mix.exs: Elixir 项目的配置文件。
• mix.lock: 依赖锁定文件。

2. 项目的启动文件介绍

Sage 项目的启动文件是 mix.exs。这个文件是 Elixir 项目的配置文件，包含了项目的依赖、版本、任务等信息。

mix.exs 文件内容示例

defmodule Sage.MixProject do
  use Mix.Project

  def project do
    [
      app: :sage,
      version: "0.1.0",
      elixir: "~> 1.10",
      start_permanent: Mix.env() == :prod,
      deps: deps()
    ]
  end

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      {:ecto, "~> 3.0"},
      {:postgrex, ">= 0.0.0"}
    ]
  end
end

启动文件介绍

• project: 定义了项目的名称、版本、Elixir 版本要求等。
• application: 定义了项目启动时需要加载的应用程序。
• deps: 定义了项目的依赖库。

3. 项目的配置文件介绍

Sage 项目的配置文件主要包括 config/config.exs 和 config/dev.exs 等。这些文件用于配置项目的运行环境、数据库连接、日志级别等。

config.exs 文件内容示例

import Config

config :sage, Sage.Repo,
  adapter: Ecto.Adapters.Postgres,
  database: "sage_dev",
  username: "user",
  password: "password",
  hostname: "localhost"

config :logger, level: :info

配置文件介绍

• config :sage, Sage.Repo: 配置数据库连接信息。
• config :logger, level: 配置日志级别。

通过这些配置文件，可以灵活地调整项目的运行环境和行为。

sage A dependency-free tool to run distributed transactions in Elixir, inspired by Sagas pattern. 项目地址: https://gitcode.com/gh_mirrors/sage/sage