summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authortamaina <tamaina@hotmail.co.jp>2024-02-13 00:54:34 +0900
committerGitHub <noreply@github.com>2024-02-13 00:54:34 +0900
commit4f80b6fa5d1195c8372a14c6e32b0e7a8287b906 (patch)
treeeae31f21789879aa8a8b37515ee6b08e2521cd80 /CONTRIBUTING.md
parentci(test-frontend): Cypressのテストの失敗時、永遠に止まらない... (diff)
downloadmisskey-4f80b6fa5d1195c8372a14c6e32b0e7a8287b906.tar.gz
misskey-4f80b6fa5d1195c8372a14c6e32b0e7a8287b906.tar.bz2
misskey-4f80b6fa5d1195c8372a14c6e32b0e7a8287b906.zip
chore: 以前の開発環境(backendにアクセスする方式)を立ち上げられるように (#13220)
* chore: 以前の開発環境(backendにアクセスする方式)を立ち上げられるように * Update scripts/dev.mjs Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com> --------- Co-authored-by: かっこかり <67428053+kakkokari-gtyih@users.noreply.github.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ac0a1ba3c1..a3263bf6aa 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -122,6 +122,19 @@ command.
If you have not changed it from the default, it will be "http://localhost:3000".
If "port" in .config/default.yml is set to something other than 3000, you need to change the proxy settings in packages/frontend/vite.config.local-dev.ts.
+### `MK_DEV_PREFER=backend pnpm dev`
+pnpm dev has another mode with `MK_DEV_PREFER=backend`.
+
+```
+MK_DEV_PREFER=backend pnpm dev
+```
+
+- This mode is closer to the production environment than the default mode.
+- Vite runs behind the backend (the backend will proxy Vite at /vite).
+- You can see Misskey by accessing `http://localhost:3000` (Replace `3000` with the port configured with `port` in .config/default.yml).
+- To change the port of Vite, specify with `VITE_PORT` environment variable.
+- HMR may not work in some environments such as Windows.
+
### Dev Container
Instead of running `pnpm` locally, you can use Dev Container to set up your development environment.
To use Dev Container, open the project directory on VSCode with Dev Containers installed.