AppFlowy-Cloud 项目下载及安装教程

AppFlowy-Cloud 项目下载及安装教程

AppFlowy-Cloud AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust. 项目地址: https://gitcode.com/gh_mirrors/ap/AppFlowy-Cloud

1、项目介绍

AppFlowy-Cloud 是 AppFlowy 生态系统的一部分，提供安全的用户认证、文件存储和实时 WebSocket 通信，以实现高效和协作的用户体验。该项目是一个开源的替代方案，用户可以完全掌控自己的数据和定制化需求。AppFlowy-Cloud 使用 Rust 语言构建，具有高性能和安全性。

2、项目下载位置

你可以通过以下链接下载 AppFlowy-Cloud 项目：

AppFlowy-Cloud GitHub 仓库

3、项目安装环境配置

在开始安装之前，你需要确保你的系统满足以下环境配置要求：

• 操作系统：Linux 或 macOS（Windows 用户可能需要使用 WSL）
• Rust 工具链：确保你已经安装了 Rust 和 Cargo。你可以通过以下命令安装 Rust：

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  

• Docker：用于运行依赖服务。你可以通过以下命令安装 Docker：

  sudo apt-get update
  sudo apt-get install docker-ce docker-ce-cli containerd.io
  

• sqlx-cli：用于数据库迁移。你可以通过以下命令安装 sqlx-cli：

  cargo install sqlx-cli
  

环境配置示例

以下是环境配置的示例图片：

4、项目安装方式

4.1 克隆项目

首先，克隆 AppFlowy-Cloud 项目到本地：

git clone https://github.com/AppFlowy-IO/AppFlowy-Cloud.git
cd AppFlowy-Cloud

4.2 配置环境变量

复制配置文件并根据需要进行编辑：

cp dev.env .env

编辑 .env 文件，配置 SMTP 等必要信息。

4.3 运行依赖服务

使用 Docker 启动依赖服务：

docker-compose -f docker-compose-dev.yml up -d

4.4 运行数据库迁移

创建数据库并运行迁移：

sqlx database create
sqlx migrate run

4.5 编译并运行项目

编译并运行 AppFlowy-Cloud 服务器：

cargo run

5、项目处理脚本

AppFlowy-Cloud 项目提供了一些脚本来简化开发和调试过程。以下是一些常用的脚本：

5.1 运行本地服务器

./scripts/run_local_server.sh

5.2 运行测试

在服务器运行后，你可以运行测试：

cargo test

5.3 调试工具

• Postgres：使用 PgAdmin 或命令行工具进行调试。
• Redis：使用 Redis CLI 进行调试。
• Minio：使用 Minio Web UI 进行文件和桶管理。
• Portainer：使用 Portainer Web UI 管理 Docker 容器。

通过以上步骤，你可以成功下载并安装 AppFlowy-Cloud 项目，并开始使用其提供的功能。

AppFlowy-Cloud AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust. 项目地址: https://gitcode.com/gh_mirrors/ap/AppFlowy-Cloud