AppFlowy Docs
Search…
Essential documentation
Design Documentation
🍎
Building on MacOS
Note:
- 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.
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 Rust and Cargo
Skip install_rust or install_cargo_make if you already installed it.
1
cd AppFlowy/frontend
Copied!
1
make flowy_dev_install
Copied!
Step 3: Install Flutter
- As AppFlowy uses the
stablechannel, you need to switch the 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-macos-desktop
Copied!
Step 4: Edit and run the application
- 1.Open the
frontendfolder located at xx/AppFlowy/frontend with VS Code. - 2.Go to the Run and Debug tab and then click AF: Clean + Rebuild All for the first time running.
img.png
- Please also check the device selection, as of now AppFlowy only supports Desktop:
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.Go to the AppFlowy/frontend/ directory.
- 2.Run the following command to build the binary depending on your architecture.
x86
aarch64
1
cargo make --profile production-mac-x86 appflowy
Copied!
1
cargo make --profile production-mac-aarch64 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/[OS]/Release/AppFlowy/.Last modified 1d ago