AppFlowy Docs
Search…
⌃K
📡

Tauri Setup

Clone AppFlowy

Clone AppFlowy
git clone [email protected]:AppFlowy-IO/AppFlowy.git

Install prerequisites

  1. 1.
    Follow the instructions here to install Tauri
  2. 2.
    Install cargo-make
# AppFlowy use cargo-make to run the scripts
cargo install cargo-make
  1. 3.
    Install AppFlowy dev tools
# install development tools
cd AppFlowy/frontend
cargo make appflowy-tauri-deps-tools
cd appflowy_tauri
npm install

IDE setup

VSCode

You can run from VSCode: Open the frontend folder located at AppFlowy/frontend with VSCode.
img.png
This option enable debugging the core process directly. Or you can run manually:
cd frontend
cargo make tauri_dev

WebStorm

Open the appflowy_tauri folder located at AppFlowy/frontend/appflowy_tauri and then run the tauri:dev.
img.png

Clean

Remove the build artifacts first when facing compiler errors.
cd frontend
cargo make tauri_clean