toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2025-01-03 21:35:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: update build guideline (#2434)

Browse Source 
Co-authored-by: Himself65 <himself65@outlook.com>
This commit is contained in:
fourdim 2023-05-22 20:18:43 +08:00 committed by GitHub
parent fd35d3427e
commit 0a49258ddd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -28,9 +28,9 @@ node_modules
# IDE - VSCode # IDE - VSCode
.vscode/* .vscode/*
!.vscode/settings.json
!.vscode/tasks.json !.vscode/tasks.json
!.vscode/launch.json !.vscode/settings.template.json
!.vscode/launch.template.json
!.vscode/extensions.json !.vscode/extensions.json
# misc # misc

6
.vscode/launch.json → .vscode/launch.template.json vendored
View File

@ -6,6 +6,12 @@
"name": "Run Dev", "name": "Run Dev",
"request": "launch", "request": "launch",
"type": "node-terminal" "type": "node-terminal"
},
{
"command": "yarn run dev:local",
"name": "Run Dev Locally",
"request": "launch",
"type": "node-terminal"
} }
] ]
} }

0
.vscode/settings.json → .vscode/settings.template.json vendored
View File

2
apps/web/README.md
View File

@ -10,7 +10,7 @@ First, run the development server:
pnpm run dev pnpm run dev
``` ```
Open [http://localhost:8080](http://localhost:3000) with your browser to see the result. Open [http://localhost:8080](http://localhost:8080) with your browser to see the result.
You can start editing the page by modifying `src/pages/workspace/[workspaceId]/all.tsx`. The page auto-updates as you edit the file. You can start editing the page by modifying `src/pages/workspace/[workspaceId]/all.tsx`. The page auto-updates as you edit the file.

6
docs/BUILDING.md
View File

@ -31,13 +31,13 @@ nvm use 18
## Setup Environment ## Setup Environment
This setup requires modern yarn (currently `3.5.0`), 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`
Reference: [Yarn installation doc](https://yarnpkg.com/getting-started/install) Reference: [Yarn installation doc](https://yarnpkg.com/getting-started/install)
```sh ```sh
corepack enable corepack enable
corepack prepare yarn@3.5.0 --activate corepack prepare yarn@stable --activate
``` ```
```sh ```sh
@ -52,7 +52,7 @@ yarn install
```shell ```shell
# Run OctoBase container in background # Run OctoBase container in background
docker pull ghcr.io/toeverything/cloud-self-hosted:nightly-latest 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 3000:3000 --runtime=runc -d 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 ```shell

2
package.json
View File

@ -13,7 +13,7 @@
"scripts": { "scripts": {
"dev": "dev-web", "dev": "dev-web",
"dev:ac": "API_SERVER_PROFILE=ac yarn workspace @affine/web dev", "dev:ac": "API_SERVER_PROFILE=ac yarn workspace @affine/web dev",
"dev:local": "API_SERVER_PROFILE=local yarn workspace @affine/web dev", "dev:local": "PORT=8080 API_SERVER_PROFILE=local yarn workspace @affine/web dev",
"dev:app": "yarn workspace @affine/electron dev:app", "dev:app": "yarn workspace @affine/electron dev:app",
"build": "yarn workspace @affine/web build", "build": "yarn workspace @affine/web build",
"build:client": "yarn workspace @affine/client-app build:app", "build:client": "yarn workspace @affine/client-app build:app",