Building on Windows
Last updated
Was this helpful?
Last updated
Was this helpful?
Notes:
The following steps are verified on
Both Windows cmd
and powershell
can be used for running commands.
If you encounter any issues, please have a look at first. If your issue is not included in the page, please create an or ask on .\
If you prefer a video tutorial click here:
You should fork the code instead if you wish to submit patches. You'll find information on that in Setting Up Your Repositories
In section "All Downloads" => "Tools for Visual Studio 2022" => "Build Tools for Visual Studio 2022".
Launch vs_BuildTools.exe
to install.
Choose "Desktop Development with C++"
Make sure to use the Flutter 3.27.4 version
Enable the specified platform first if you don't enable it before and then select the desktop device.
Fix any problems reported by flutter doctor
Install LLVM
Install rust
Call rustup.exe from powershell or cmd
It is a good idea to check your rustc version after this step, and compare it to the current supported one in AppFlowy. Run the command:
In case you need to checkout/downgrade your version, you can replace the version number in this command:
Install cargo make
Install duckscript
Add Powershell to the PATH
Add C:\Windows\System32
to the PATH to prevent Powershell build commands crashing.
Install openssl
Run installer and install Openssl where you want
Add bin
folder to the PATH (ie: G:\Compilation\OpenSSL\bin
)
Create a new User variable (using the same window as the PATH editor): Name it OPENSSL_DIR
with same value as bin folder (ie G:\Compilation\OpenSSL\bin
)
Install perl
Run installer
Check Perl is installed with following command
Install Dart extension for Visual Studio Code
Enable the Dart protoc_plugin
For Windows 11: Activate Developer Mode
Go to Settings > Privacy & Security > switch ON Developer Mode
[VS Code]
Open the frontend
folder located at xx/AppFlowy/frontend with VS Code.
Go to the Run and Debug tab and then click AF-desktop: Clean + Rebuild All for the first time running.
Go to the AppFlowy/frontend/ directory.
Run the following command to create the binary.
The scripts are located in the AppFlowy/frontend/Makefile.toml file.
The resulting binary file is located in AppFlowy/frontend/appflowy/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
Install Visual Studio 2022 build tools. Download from
Install vcpkg according to . Make sure to add vcpkg installation folder to your .
Install flutter according to .
Based on your platform, install the LLVM using the . Additionally, make sure to add it to the system path.
Download rustup.exe
from
Look for rustc 1.80.1
- You can find the supported version .
Download openssl_1.1.1n_win32_complete.zip
from
Note: In cse the OpenSSL link resolves to a dead download, you can install OpenSSL from this . (From )
Download Perl for Windows (called Strawberry perl) from (choose x64 installer)
If you encounter any issues, have a look at first. If your issue is not included in the page, please create an or ask on .