Skip to content

BUILD_FROM_SOURCE_20250809205822.md

Latest commit

 

History

History
219 lines (158 loc) · 7.03 KB

BUILD_FROM_SOURCE_20250809205822.md

File metadata and controls

219 lines (158 loc) · 7.03 KB

Building AppFlowy from Source

This guide provides comprehensive instructions for building AppFlowy from source code on all supported platforms.

Prerequisites

Before building AppFlowy, ensure you have the following installed:

All Platforms

Platform-Specific Requirements

Windows

macOS

  • Xcode Command Line Tools: xcode-select --install

Linux

  • Build essentials: sudo apt install build-essential pkg-config libssl-dev
  • Additional dependencies: sudo apt install clang cmake ninja-build pkg-config libgtk-3-dev

Building for Desktop

1. Clone the Repository

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

2. Build for Your Platform

Windows

cd frontend
cargo make appflowy-windows

macOS

cd frontend
cargo make appflowy-macos

Linux

cd frontend
cargo make appflowy-linux

3. Run the Application

After building, the executable will be located in:

  • Windows: frontend/appflowy_flutter/product/[version]/windows/Release/AppFlowy/
  • macOS: frontend/appflowy_flutter/product/[version]/macos/Release/AppFlowy.app/
  • Linux: frontend/appflowy_flutter/product/[version]/linux/Release/AppFlowy/

Building for Mobile

iOS

Prerequisites

  • macOS with Xcode installed
  • iOS development setup for Flutter

Build Steps

cd frontend
cargo make appflowy-ios

The iOS app will be built and available in frontend/appflowy_flutter/build/ios/.

Android

Prerequisites

All Platforms:

  • Android NDK version 24
  • cargo-ndk: cargo install cargo-ndk

Additional Setup:

  1. Set Environment Variables

    Windows:

    set ANDROID_NDK_HOME=C:\Users\%USERNAME%\AppData\Local\Android\Sdk\ndk\24.0.8215888

    macOS/Linux:

    export ANDROID_NDK_HOME=~/Android/Sdk/ndk/24.0.8215888

  2. Configure Cargo for Android

    Create or edit ~/.cargo/config (Linux/macOS) or %USERPROFILE%\.cargo\config (Windows):

    Linux/macOS:

    [target.aarch64-linux-android]
ar = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-ar"
linker = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android29-clang"

[target.armv7-linux-androideabi]
ar = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-ar"
linker = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi29-clang"

[target.i686-linux-android]
ar = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-ar"
linker = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android29-clang"

[target.x86_64-linux-android]
ar = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-ar"
linker = "/home/user/Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/bin/x86_64-linux-android29-clang"

    Windows:

    [target.aarch64-linux-android]
ar = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\llvm-ar.exe"
linker = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\aarch64-linux-android29-clang.exe"

[target.armv7-linux-androideabi]
ar = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\llvm-ar.exe"
linker = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\armv7a-linux-androideabi29-clang.exe"

[target.i686-linux-android]
ar = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\llvm-ar.exe"
linker = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\i686-linux-android29-clang.exe"

[target.x86_64-linux-android]
ar = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\llvm-ar.exe"
linker = "C:\\Users\\%USERNAME%\\AppData\\Local\\Android\\Sdk\\ndk\\24.0.8215888\\toolchains\\llvm\\prebuilt\\windows-x86_64\\bin\\x86_64-linux-android29-clang.exe"

  3. NDK 24 Clang Fix

    Create a file named libgcc.a with this content:

    INPUT(-lunwind)

    Linux/macOS: Place it in Android/Sdk/ndk/24.0.8215888/toolchains/llvm/prebuilt/linux-x86_64/lib64/clang/14.0.1/lib/linux/

    Windows: Place it in Android\Sdk\ndk\24.0.8215888\toolchains\llvm\prebuilt\windows-x86_64\lib64\clang\14.0.1\lib\linux\

    Copy this file to the following subdirectories: aarch64, arm, i386, and x86_64.

Build Steps

cd frontend
cargo make appflowy-android

The Android APK will be built and available in frontend/appflowy_flutter/build/app/outputs/flutter-apk/.

Development Builds

For faster development builds without optimizations:

Desktop Development

cd frontend
cargo make appflowy-dev  # Uses platform-specific aliases

Mobile Development

# iOS development build
cd frontend
cargo make appflowy-ios-dev

# Android development build
cd frontend
cargo make appflowy-android-dev

Troubleshooting

Common Issues

  1. Flutter Doctor Issues: Run flutter doctor to check for missing dependencies
  2. Rust Version: Ensure you're using Rust 1.70 or later
  3. Path Issues: Make sure all tools are in your system PATH
  4. NDK Issues: Verify ANDROID_NDK_HOME is set correctly

Platform-Specific Issues

Windows

  • Ensure Visual Studio C++ tools are installed
  • Check that vcpkg is properly configured
  • Use PowerShell or Command Prompt, not Git Bash for building

macOS

  • Ensure Xcode Command Line Tools are installed
  • For iOS builds, you need a full Xcode installation

Linux

  • Install all required system dependencies
  • Check that pkg-config can find required libraries

Getting Help

Additional Resources