docs: add VITE_API_BASE_URL for remote/VPS deployment#554
Open
JiayuuWang wants to merge 1 commit into666ghj:mainfrom
Open
docs: add VITE_API_BASE_URL for remote/VPS deployment#554JiayuuWang wants to merge 1 commit into666ghj:mainfrom
JiayuuWang wants to merge 1 commit into666ghj:mainfrom
Conversation
Document how to configure frontend-backend communication for remote access. The Vite dev server proxy (/api -> localhost:5001) only works in local development. When deploying on a VPS or accessing from a different machine, users must set VITE_API_BASE_URL to the server's actual IP/URL. Changes: - Add VITE_API_BASE_URL to .env.example with usage instructions - Add remote deployment note to README.md (English) - Add remote deployment note to README-ZH.md (Chinese)
dosubot
Bot
added
size:S
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
VITE_API_BASE_URLenvironment variable for remote/VPS deploymentChanges
.env.example- AddedVITE_API_BASE_URLwith explanationREADME.md- Added "Remote/VPS Deployment Note" sectionREADME-ZH.md- Added Chinese version of remote deployment noteWhy
When deploying MiroFish on a VPS and accessing remotely, users get "Network error" because the axios client defaults to
http://localhost:5001. The Vite dev server proxy only works locally.