toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2024-11-26 16:32:58 +03:00
Code Issues Packages Projects Releases Wiki Activity
6a0209dde2
AFFiNE/docs/building-desktop-client-app.md
Himself65 05ac48b693
docs: update build guideline (#1630)
2023-03-21 00:12:42 -05:00

1.4 KiB
Raw Blame History

Building AFFiNE Desktop Client App

Table of Contents

Prerequisites

Before you start building AFFiNE Desktop Client Application, please follow the Tauri getting started > prerequisites guide to set up your environment.

Note that if you encounter any issues with installing Rust and crates, try following this guide (zh-CN) to set up alternative registries.

Development

To run AFFiNE Desktop Client Application locally, run the following commands in apps/desktop:


yarn install
yarn build:preload
yarn dev:app

Build

To build the desktop client application, run yarn build:app in apps/desktop. Once the build is complete, you can find the paths to the binaries in the terminal output.

Finished 2 bundles at:
    /Users/affine/Documents/GitHub/AFFiNE/apps/desktop/src-tauri/target/release/bundle/macos/AFFiNE.app
    /Users/affine/Documents/GitHub/AFFiNE/apps/desktop/src-tauri/target/release/bundle/dmg/AFFiNE_0.0.2_aarch64.dmg

CI

Please refer to .github/workflows/client-app.yml for the CI workflow. It will:

  • run for pull requests and pushes to master branch
  • build the app for all supported platforms
  • upload the artifacts to GitHub Actions