You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/code-studio/README.md
+5-18Lines changed: 5 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,16 @@ In the application directory, run `npm install` to install dependencies, then us
8
8
9
9
### `npm start`
10
10
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.
12
12
13
13
### `npm run start-rewired`
14
14
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.
16
16
17
17
### `npm test`
18
18
19
19
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.
20
20
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
-
27
21
### `npm run build`
28
22
29
23
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
93
87
94
88
## Data Storage
95
89
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.
97
91
98
92
### Redux Data
99
93
@@ -118,18 +112,11 @@ The styleguide uses [Storybook](https://storybook.js.org/) and can be accessed u
118
112
119
113
### Legacy Style Guide
120
114
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.
122
116
123
117
## Architecture
124
118
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.
0 commit comments