From 0a49258dddad7cec257e88775e08fb0c7807c607 Mon Sep 17 00:00:00 2001
From: fourdim <59462000+fourdim@users.noreply.github.com>
Date: Mon, 22 May 2023 20:18:43 +0800
Subject: [PATCH] docs: update build guideline (#2434)

Co-authored-by: Himself65 <himself65@outlook.com>
---
 .gitignore                                        | 4 ++--
 .vscode/{launch.json => launch.template.json}     | 6 ++++++
 .vscode/{settings.json => settings.template.json} | 0
 apps/web/README.md                                | 2 +-
 docs/BUILDING.md                                  | 6 +++---
 package.json                                      | 2 +-
 6 files changed, 13 insertions(+), 7 deletions(-)
 rename .vscode/{launch.json => launch.template.json} (55%)
 rename .vscode/{settings.json => settings.template.json} (100%)

diff --git a/.gitignore b/.gitignore
index ba02904ee8..f0f8ca3059 100644
--- a/.gitignore
+++ b/.gitignore
@@ -28,9 +28,9 @@ node_modules
 
 # IDE - VSCode
 .vscode/*
-!.vscode/settings.json
 !.vscode/tasks.json
-!.vscode/launch.json
+!.vscode/settings.template.json
+!.vscode/launch.template.json
 !.vscode/extensions.json
 
 # misc
diff --git a/.vscode/launch.json b/.vscode/launch.template.json
similarity index 55%
rename from .vscode/launch.json
rename to .vscode/launch.template.json
index eb4d97a729..eeb8902687 100644
--- a/.vscode/launch.json
+++ b/.vscode/launch.template.json
@@ -6,6 +6,12 @@
       "name": "Run Dev",
       "request": "launch",
       "type": "node-terminal"
+    },
+    {
+      "command": "yarn run dev:local",
+      "name": "Run Dev Locally",
+      "request": "launch",
+      "type": "node-terminal"
     }
   ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.template.json
similarity index 100%
rename from .vscode/settings.json
rename to .vscode/settings.template.json
diff --git a/apps/web/README.md b/apps/web/README.md
index 0462cf7a4d..2c45fd1844 100644
--- a/apps/web/README.md
+++ b/apps/web/README.md
@@ -10,7 +10,7 @@ First, run the development server:
 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.
 
diff --git a/docs/BUILDING.md b/docs/BUILDING.md
index 8a7608a607..29d3e1fee6 100644
--- a/docs/BUILDING.md
+++ b/docs/BUILDING.md
@@ -31,13 +31,13 @@ nvm use 18
 
 ## 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)
 
 ```sh
 corepack enable
-corepack prepare yarn@3.5.0 --activate
+corepack prepare yarn@stable --activate
 ```
 
 ```sh
@@ -52,7 +52,7 @@ yarn install
 ```shell
 # Run OctoBase container in background
 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
diff --git a/package.json b/package.json
index f1def835cf..598249d8f6 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,7 @@
   "scripts": {
     "dev": "dev-web",
     "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",
     "build": "yarn workspace @affine/web build",
     "build:client": "yarn workspace @affine/client-app build:app",