Skip to content

BUILDING.md

Latest commit

 

History

History
109 lines (72 loc) · 2.57 KB

BUILDING.md

File metadata and controls

109 lines (72 loc) · 2.57 KB

Building AFFiNE Web

Warning:

This document has not been updated for a while. If you find any outdated information, please feel free to open an issue or submit a PR.

Note For developing & building desktop client app, please refer to building-desktop-client-app.md

Table of Contents

Prerequisites

AFFiNE client has both Node.js & Rust toolchains.

Install Node.js

We suggest develop our product under node.js LTS(Long-term support) version

Option 1: Manually install node.js

install Node LTS version

Up to now, the major node.js version is 18.x

Option 2: Use node version manager

install fnm

fnm use

Install Rust Tools

Please follow the official guide at https://www.rust-lang.org/tools/install.

Setup Node.js Environment

This setup requires modern yarn (currently 3.x), run this if your yarn version is 1.x

Reference: Yarn installation doc

corepack enable
corepack prepare yarn@stable --activate
# install dependencies
yarn install

Build Native Dependencies

Run the following script. It will build the native module at /packages/native and build Node.js binding using NAPI.rs. This could take a while if you build it for the first time. Note: use strip from system instead of binutils if you are running MacOS. see problem here

yarn workspace @affine/native build

Build Infra

yarn run build:infra

Build Plugins

yarn run build:plugins

Build Server Dependencies

yarn workspace @affine/storage build

Testing

Adding test cases is strongly encouraged when you contribute new features and bug fixes.

We use Playwright for E2E test, and vitest for unit test. To test locally, please make sure browser binaries are already installed via npx playwright install. Also make sure you have built the @affine/core workspace before running E2E tests.

Unit Test

yarn test

E2E Test

# there are `affine-local`, `affine-legacy/*`, `affine-local`, `affine-plugin`, `affine-prototype` e2e tests,
#   which are run under different situations.
cd tests/affine-local
yarn e2e