luulam/AFFiNE
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update building.md for electron (#2800)

Browse Source
This commit is contained in:
Peng Xiao
2023-06-16 13:15:42 +08:00
committed by GitHub
parent 9422b93857
commit 0553ca3c02
1 changed files with 27 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/BUILDING.md
View File

@@ -12,15 +12,19 @@
## Prerequisites ## 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 We suggest develop our product under node.js LTS(Long-term support) version
### Option 1: Manually install node.js #### Option 1: Manually install node.js
install [Node LTS version](https://nodejs.org/en/download) install [Node LTS version](https://nodejs.org/en/download)
> Up to now, the major node.js version is 18.x > Up to now, the major node.js version is 18.x
### Option 2: Use node version manager #### Option 2: Use node version manager
install [nvm](https://github.com/nvm-sh/nvm) install [nvm](https://github.com/nvm-sh/nvm)
@@ -29,7 +33,11 @@ nvm install 18
nvm use 18 nvm use 18
``` ```
## Setup Environment ### 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` This setup requires modern yarn (currently `3.x`), run this if your yarn version is `1.x`
@@ -45,38 +53,34 @@ corepack prepare yarn@stable --activate
yarn install yarn install
``` ```
## Start Development Server ### Build Native Dependencies
### Option 1: Local OctoBase Run the following script. It will build the native module at [`/packages/native`](/packages/native) and build Node.js binding using [NAPI.rs](https://napi.rs/).
This could take a while if you build it for the first time.
```shell ```
# Run OctoBase container in background yarn workspace @affine/native build
docker pull ghcr.io/toeverything/cloud-self-hosted:nightly-latest
docker run --env=SIGN_KEY=test123 --env=RUST_LOG=debug --env=JWST_DEV=1 --env=PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin --workdir=/app -p 127.0.0.1:3000:3000 --runtime=runc -d ghcr.io/toeverything/cloud-self-hosted:nightly-latest
``` ```
```shell ## Debugging the Electron App
# Run AFFiNE Web in development mode
yarn dev:local You need to run two scripts to run the app in development mode
Firstly, run the web app which is served at :8080
```
yarn dev # you may want to chose `dev - 100.84.105.99:11001` when selecting the dev server
``` ```
### Option 2: Remote OctoBase Secondly, bring up the electron app
```shell ```
yarn dev yarn workspace @affine/electron dev
``` ```
you might need set environment variables in `.env.local` file. If everything goes well, you should see the AFFiNE App window popping up in a few seconds. 🎉
See our [template](../apps/web/.env.local.template).
Then, the playground page should work at [http://localhost:8080/](http://localhost:8080/)
For more details, see [apps/web/README.md](../apps/web/README.md)
## Testing ## Testing
> Local OctoBase is required for testing. Otherwise, the affine part of the tests will fail.
Adding test cases is strongly encouraged when you contribute new features and bug fixes. Adding test cases is strongly encouraged when you contribute new features and bug fixes.
We use [Playwright](https://playwright.dev/) for E2E test, and [vitest](https://vitest.dev/) for unit test. We use [Playwright](https://playwright.dev/) for E2E test, and [vitest](https://vitest.dev/) for unit test.