AppFlowy/doc/BUILD_ON_LINUX.md
Alex Chen 0dcaa6be2f [Build] Fix Linux build instruction
1. BUILD_ON_LINUX.md
  - Remove brew dependency
  - Update command for development in step 9 & 10
2. Fix file name typo for BUILD_ON_WINDOWS.md
2021-11-20 14:35:44 +08:00

2.3 KiB

How to build on Linux, please follow these simple steps.

Step 1:

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

Step 2:

Note:

  1. Following steps are verified on

    • lubuntu 20.04 - X86_64
    • ubuntu 20.04 - aarch64
    • redhat - X86_64
    • Arch Linux - X86_64
    • Deepin - X86_64
    • Raspberry Pi OS - aarch64
  2. You may need to disable hardware 3D acceleration if you are running in a VM. Otherwise certain GL failures will prevent app from launching

  3. Install pre-requests

sudo apt-get install curl build-essential libsqlite3-dev libssl-dev clang cmake ninja-build pkg-config libgtk-3-dev
  1. Install rust on Linux
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
rustup toolchain install nightly
rustup default nightly
  1. Install flutter according to https://docs.flutter.dev/get-started/install/linux
git clone https://github.com/flutter/flutter.git
cd flutter
echo "export PATH=\$PATH:"`pwd`"/bin" >> ~/.profile
export PATH="$PATH:`pwd`/bin"
flutter channel dev
flutter config --enable-linux-desktop
  1. Fix problem reported by flutter doctor
flutter doctor
# install Android toolchain (optional)
# install Chrome (optional)
  1. Install cargo make
cd appflowy
cargo install --force cargo-make
  1. Install duckscript
cargo install --force duckscript_cli
  1. Check pre-request
cargo make flowy_dev
  1. Generate protobuf for dart (optional)
cargo make -p development-linux-x86 pb
  1. Build flowy-sdk-dev (dart-ffi) (optional), step 10 covers this step
# for development
cargo make --profile development-linux-x86 flowy-sdk-dev

# for production
cargo make --profile production-linux-x86 flowy-sdk-release
  1. Build app_flowy
# for development
cargo make -p development-linux-x86 appflowy-linux-dev

# for production, find binary from app_flowy/product/<version>/linux/<build type>/AppFlowy/
cargo make -p production-linux-x86 appflowy-linux

# tips
# run Linux GUI application through x11 on windows (use MobaXterm)
# for instance:
# export DISPLAY=localhost:10
# cd app_flowy/product/0.0.2/linux/Release/AppFlowy
# ./app_flowy

Step 3: Server side application

Note: You can launch postgresql server by using docker container

TBD