-
Notifications
You must be signed in to change notification settings - Fork 1
feat: configure UI host and port from config file #34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
joan-code6
wants to merge
1
commit into
main
Choose a base branch
from
codex/config-file-host-port-ui
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,17 @@ | ||
| # Lanis WEB UI | ||
| # Lanis WEB UI | ||
|
|
||
| ## Configuration | ||
|
|
||
| Edit [`config.json`](config.json) before starting the UI: | ||
|
|
||
| ```json | ||
| { | ||
| "host": "0.0.0.0", | ||
| "port": 3000, | ||
| "apiUrl": "http://localhost:8000" | ||
| } | ||
| ``` | ||
|
|
||
| `host` and `port` configure the Vite development and preview servers. `apiUrl` | ||
| sets the default LANIS API address used by the browser. No environment variables | ||
| are required for these settings. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "host": "0.0.0.0", | ||
| "port": 3000, | ||
| "apiUrl": "http://localhost:8000" | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1 @@ | ||
| /// <reference types="vite/client" /> | ||
|
|
||
| interface ImportMetaEnv { | ||
| readonly VITE_API_URL: string | ||
| // more env variables... | ||
| } | ||
|
|
||
| interface ImportMeta { | ||
| readonly env: ImportMetaEnv | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,22 @@ | ||
| import uiConfig from './config.json' | ||
| import { defineConfig } from 'vite' | ||
| import react from '@vitejs/plugin-react' | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [react()], | ||
| server: { | ||
| port: 3000, | ||
| host: true, | ||
| port: uiConfig.port, | ||
| host: uiConfig.host, | ||
| proxy: { | ||
| '/api': { | ||
| target: 'http://localhost:8000', | ||
| target: uiConfig.apiUrl, | ||
| changeOrigin: true, | ||
| rewrite: (path) => path.replace(/^\/api/, ''), | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
| preview: { | ||
| port: uiConfig.port, | ||
| host: uiConfig.host, | ||
| }, | ||
| }) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a prebuilt
distis started withvite preview, changingconfig.jsonas README.md instructs updates the preview host and port but not the browser's API address: importing the JSON here causes Vite to inlineapiUrlduringvite build. This is especially problematic for a single artifact deployed to multiple environments, because every client continues using the build-time URL—by default its ownlocalhost:8000—until the application is rebuilt. Either expose the configuration as a runtime-loaded public file or document and enforce thatapiUrlmust be set before building.Useful? React with 👍 / 👎.