AppFlowy Docs
Search…
πŸͺŸ
Building on Windows
Notes:
  • The following steps are verified on
    • Windows 10 X86_64
    • Windows 10 arm64
    • Windows 11 X86_64
    • Windows 11 arm64
  • Both Windows cmd and powershell can be used for running commands.
  • If you encounter any issues, please have a look at Troubleshooting first. If your issue is not included in the page, please create an issue or ask on Discord.

Step 1: Get the source code

You should fork the code instead if you wish to submit patches. You'll find information on that in Setting Up Your Repositories​
1
git clone https://github.com/AppFlowy-IO/appflowy.git
Copied!

Step 2: Install your build environment

  • Install Visual Studio 2022 build tools. Download from https://visualstudio.microsoft.com/downloads/​
    • In section "All Downloads" => "Tools for Visual Studio 2022" => "Build Tools for Visual Studio 2022".
    • Launch vs_BuildTools.exe to install.
  • Install vcpkg according to this page. Make sure to add vcpkg installation folder to your PATH environment variable.
  • Install flutter according to this page.
  • Make sure to enable the flutter stable channel
1
flutter channel stable
Copied!
  • Enable the specified platform first if you don't enable it before and then select the desktop device.
1
flutter config --enable-windows-desktop
Copied!
  • Fix any problems reported by flutter doctor
1
flutter doctor
Copied!
1
.\rustup-init.exe --default-toolchain stable --default-host x86_64-pc-windows-msvc -y
Copied!
  • Install cargo make
You probably need to re-open your terminal to get the cargo command in your PATH
1
cd AppFlowy/frontend
Copied!
1
cargo install --force cargo-make
Copied!
  • Install duckscript
1
cargo install --force duckscript_cli
Copied!

Step 3: Edit and run the application

[VS Code]
  1. 1.
    Open the frontend folder located at xx/AppFlowy/frontend with VS Code.
  2. 2.
    Go to the Run and Debug tab and then click AF: Clean + Rebuild All for the first time running.
img.png
If you encounter any issues, have a look at Troubleshooting first. If your issue is not included in the page, please create an issue or ask on Discord.

Building in release mode

  1. 1.
    Go to the AppFlowy/frontend/ directory.
  2. 2.
    Run the following command to create the binary.
1
cargo make --profile production-windows-x86 appflowy
Copied!
The scripts are located in the AppFlowy/frontend/Makefile.toml file.
The resulting binary file is located in AppFlowy/frontend/app_flowy/product/x.x.x/Windows/Release/AppFlowy/.
If using a virtual machine
  • Run Linux GUI application through x11 on windows (use MobaXterm) for instance:
export DISPLAY=localhost:10