Skip to content

Commit 8883a66

Browse files
authored
Update default port to 4000, fix up/remove parts of the readme that were incorrect (#115)
1 parent 553e555 commit 8883a66

File tree

2 files changed

+6
-18
lines changed

2 files changed

+6
-18
lines changed

packages/code-studio/.env.development

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ REACT_APP_CORE_API_URL=http://localhost:10000/jsapi
44
REACT_APP_NOTEBOOKS_URL=http://localhost:10000/notebooks
55
REACT_APP_ROUTER_BASE_NAME=/
66
REACT_APP_INTERNAL_PLUGINS=ExamplePlugin
7+
PORT=4000
78

89
# This converts all eslint errors to warnings in dev
910
# If they are left as errors, the dev bundle will fail to build

packages/code-studio/README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,16 @@ In the application directory, run `npm install` to install dependencies, then us
88

99
### `npm start`
1010

11-
Start the project in development mode, open at http://localhost:3000. Page automatically updates when changes are saved.
11+
Start the project in development mode, open at http://localhost:4000. Page automatically updates when changes are saved.
1212

1313
### `npm run start-rewired`
1414

15-
Start the project in development mode with experimental fast refresh enabled. Open at http://localhost:3000. Page should automatically refresh on changes while keeping state and not requiring you to login after each change.
15+
Start the project in development mode with experimental fast refresh enabled. Open at http://localhost:4000. Page should automatically refresh on changes while keeping state and not requiring you to login after each change.
1616

1717
### `npm test`
1818

1919
Start continuous unit tests. We use [Jest](https://jestjs.io) to run end-to-end tests. Tests will rerun on changed files, or you can change modes by pressing 'a' to run ALL tests continuously.
2020

21-
### `npm run test:e2e`
22-
23-
Start the end-to-end testing UI. We use [Cypress](https://cypress.io) to run end-to-end tests. This defaults to testing http://localhost:3000, as specified in `cypress.json`. You should start your test server using `npm start` first. You can override these values in your own `cypress.env.json` file to point to a remote server if you wish.
24-
25-
To run a smoke test in headless mode, run `npm run test:e2e:smoke`. The current smoke test requires dashboards/workspace to already be created. In the future, we should refine the smoke tests to reset the database to an expected state before running the tests. More detail in [Cypress Best Practices](https://docs.cypress.io/guides/references/best-practices.html#Dangling-state-is-your-friend).
26-
2721
### `npm run build`
2822

2923
Build a production build. Output goes to the `./build` folder. Start up production server after build with `serve -s build` (may need to install `serve` first, with `npm install -g serve`)
@@ -93,7 +87,7 @@ VSCode Typescript Version Settings
9387

9488
## Data Storage
9589

96-
There is the data for the current session stored in the local redux state (Redux Data), and data stored remotely in the `workspaceData` table in the `WebClientData` PQ on the server.
90+
There is the data for the current session stored in the local redux state (Redux Data), and data persisted between sessions is stored in browser storage.
9791

9892
### Redux Data
9993

@@ -118,18 +112,11 @@ The styleguide uses [Storybook](https://storybook.js.org/) and can be accessed u
118112

119113
### Legacy Style Guide
120114

121-
When running in development mode (`npm run start`), a style guide is served up at http://localhost:3000/styleguide. This is for legacy purposes now while everything is ported over to Storybook. Do NOT add new components to this styleguide, only use it for reference if things are missing in Storybook.
115+
When running in development mode (`npm run start`), a style guide is served up at http://localhost:4000/styleguide. This is for legacy purposes now while everything is ported over to Storybook. Do NOT add new components to this styleguide, only use it for reference if things are missing in Storybook.
122116

123117
## Architecture
124118

125-
At a high level, the Web UI uses the Iris API to communicate with the servers/workers necessary. For details on the Iris API,see the [Web Developers Guide](../WebDevelopersGuide.md). For more details on the sockets and ports used, see [Network Services](https://docs.deephaven.io/latest/Content/runbook/OpsGuide.htm?Highlight=socket%20ports#Network_Services) and [Web API](https://docs.deephaven.io/latest/Content/systemAdmin/sec_webAPI.htm) in our docs.
126-
127-
```mermaid
128-
graph TD
129-
A[Web UI] -->B[Iris API]
130-
B --> |Websocket| C[Web API Server]
131-
B --> |Websockets| D[Query Workers]
132-
```
119+
For more details on the sockets and ports used, see [Network Services](https://docs.deephaven.io/latest/Content/runbook/OpsGuide.htm?Highlight=socket%20ports#Network_Services) and [Web API](https://docs.deephaven.io/latest/Content/systemAdmin/sec_webAPI.htm) in our docs.
133120

134121
### Dashboards
135122

0 commit comments

Comments
 (0)