Skip to content
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

docs: Fix VITE_CORE_API_URL in README.md #1102

Merged
merged 5 commits into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ We are still using node 16.x and npm 8.x. If you are [using nvm](https://github.
- `npm run e2e`: Runs the Playwright end-to-end tests locally.
- `npm run e2e:headed`: Runs end-to-end tests in headed mode debug mode. Useful if you need to debug why a particular test isn't work. For example, to debug the `table.spec.ts` test directly, you could run `npm run e2e:headed -- ./tests/table.spec.ts`.

Edit `.env.local` in each package to contain the following pointing to your local DHC address. These are needed for the session websocket and for things like notebooks to be proxied correctly by Vite.
If your DHC address is different from the default `http://localhost:10000`, edit `.env.local` in each package to contain the following pointing to your local DHC. These are needed for the session websocket and for things like notebooks to be proxied correctly by Vite.
mattrunyon marked this conversation as resolved.
Show resolved Hide resolved

```
VITE_CORE_API_URL=http://localhost:10000/jsapi
VITE_PROXY_URL=http://localhost:10000
VITE_CORE_API_URL=<jsapi-path>
vbabich marked this conversation as resolved.
Show resolved Hide resolved
VITE_PROXY_URL=http://<dhc-host>:<port>
```

## Package Overview
Expand Down
1 change: 1 addition & 0 deletions packages/code-studio/.env
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ VITE_CORE_API_URL=/jsapi
VITE_CORE_API_NAME=dh-core.js
VITE_OPEN_API_NAME=dh-internal.js
VITE_PLUGIN_URL=/ide/plugins/
VITE_PROXY_URL=http://localhost:10000
VITE_NOTEBOOKS_URL=/notebooks
VITE_LAYOUTS_URL=/layouts
VITE_ENABLE_LOG_PROXY=true
Expand Down
2 changes: 0 additions & 2 deletions packages/code-studio/.env.development
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@ BASE_URL=/
VITE_INTERNAL_COMPONENT_PLUGINS=ExamplePlugin
PORT=4000
VITE_LOG_LEVEL=4

VITE_PROXY_URL=http://localhost:10000
1 change: 1 addition & 0 deletions packages/embed-chart/.env
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ VITE_CORE_API_NAME=dh-core.js
VITE_BUILD_PATH=./build
VITE_LOG_LEVEL=2
VITE_FAVICON=./favicon-cc-app.svg
VITE_PROXY_URL=http://localhost:10000
2 changes: 0 additions & 2 deletions packages/embed-chart/.env.development
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@ VITE_FAVICON=./favicon-cc-app-dev.svg

# 4020 So not to conflict with code-studio
PORT=4020

VITE_PROXY_URL=http://localhost:10000
1 change: 1 addition & 0 deletions packages/embed-grid/.env
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ VITE_CORE_API_NAME=dh-core.js
VITE_BUILD_PATH=./build
VITE_LOG_LEVEL=2
VITE_FAVICON=./favicon-cc-app.svg
VITE_PROXY_URL=http://localhost:10000
2 changes: 0 additions & 2 deletions packages/embed-grid/.env.development
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@ VITE_FAVICON=./favicon-cc-app-dev.svg

# 4010 So not to conflict with code-studio
PORT=4010

VITE_PROXY_URL=http://localhost:10000