phoenix_sync 的安装和配置教程

项目基础介绍

phoenix_sync 是一个为 Postgres 背后的 Phoenix 应用程序添加实时同步功能的库。它允许开发者构建端到端的实时多用户应用程序，而无需编写 JavaScript 代码，也无需担心消息传递、重新连接、缓存失效或轮询数据库以获取更改。

主要编程语言

该项目主要使用 Elixir 语言编写，它是 Phoenix 框架的基础语言。

项目使用的关键技术和框架

phoenix_sync 集成了以下关键技术和框架：

• Phoenix: 一个构建在 Elixir 语言之上的 Web 框架。
• ElectricSQL: 用于核心同步、扇出和数据传递的库。
• Ecto: 一个为 Elixir 提供 ORM 功能的库，用于与数据库交互。

安装和配置准备工作

在开始安装 phoenix_sync 之前，请确保您的开发环境满足以下要求：

• Elixir版本至少为1.12.0。
• Phoenix框架版本至少为1.5.0。
• 已经安装并配置好 PostgreSQL 数据库。

安装步骤

以下是详细的安装步骤：

1. 克隆项目仓库

   首先，您需要从 GitHub 上克隆 phoenix_sync 项目：

   git clone https://github.com/electric-sql/phoenix_sync.git
   cd phoenix_sync
   

2. 安装依赖

   在项目目录中，使用 mix 工具安装项目依赖：

   mix deps.get
   

3. 配置应用程序

   在项目根目录下，编辑 config/config.exs 文件，配置您的数据库连接信息：

   config :phoenix_sync, PhoenixSync.Repo,
     username: "your_username",
     password: "your_password",
     database: "your_database",
     hostname: "localhost",
     pool_size: 10
   

4. 迁移数据库

   在配置完数据库后，执行以下命令以迁移数据库：

   mix ecto.create
   mix ecto.migrate
   

5. 启动 Phoenix 应用程序

   使用以下命令启动 Phoenix 应用程序：

   mix phx.server
   

现在，您的 phoenix_sync 应用程序应该已经安装并配置完毕，可以开始使用了。

请确保遵循项目的官方文档以了解更多关于如何使用 phoenix_sync 的信息。