Skip to content

Commit 966b154

Browse files
Update web README.md (#3496)
2 parents 919b81c + 95fa666 commit 966b154

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

invokeai/frontend/web/docs/API_CLIENT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ We need to start the nodes web server, which serves the OpenAPI schema to the ge
2626

2727
```bash
2828
# from the repo root
29-
python scripts/invoke-new.py --web
29+
python scripts/invokeai-web.py
3030
```
3131

32-
2. Generate the API client.
32+
2. Generate the API client.
3333

3434
```bash
3535
# from invokeai/frontend/web/

invokeai/frontend/web/docs/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,14 @@ Code in `invokeai/frontend/web/` if you want to have a look.
1212

1313
## Stack
1414

15-
State management is Redux via [Redux Toolkit](https://github.com/reduxjs/redux-toolkit). Communication with server is a mix of HTTP and [socket.io](https://github.com/socketio/socket.io-client) (with a custom redux middleware to help).
15+
State management is Redux via [Redux Toolkit](https://github.com/reduxjs/redux-toolkit). We lean heavily on RTK:
16+
- `createAsyncThunk` for HTTP requests
17+
- `createEntityAdapter` for fetching images and models
18+
- `createListenerMiddleware` for workflows
19+
20+
The API client and associated types are generated from the OpenAPI schema. See API_CLIENT.md.
21+
22+
Communication with server is a mix of HTTP and [socket.io](https://github.com/socketio/socket.io-client) (with a simple socket.io redux middleware to help).
1623

1724
[Chakra-UI](https://github.com/chakra-ui/chakra-ui) for components and styling.
1825

@@ -37,9 +44,15 @@ From `invokeai/frontend/web/` run `yarn install` to get everything set up.
3744
Start everything in dev mode:
3845

3946
1. Start the dev server: `yarn dev`
40-
2. Start the InvokeAI Nodes backend: `python scripts/invokeai-new.py --web # run from the repo root`
47+
2. Start the InvokeAI Nodes backend: `python scripts/invokeai-web.py # run from the repo root`
4148
3. Point your browser to the dev server address e.g. <http://localhost:5173/>
4249

50+
#### VSCode Remote Dev
51+
52+
We've noticed an intermittent issue with the VSCode Remote Dev port forwarding. If you use this feature of VSCode, you may intermittently click the Invoke button and then get nothing until the request times out. Suggest disabling the IDE's port forwarding feature and doing it manually via SSH:
53+
54+
`ssh -L 9090:localhost:9090 -L 5173:localhost:5173 user@host`
55+
4356
### Production builds
4457

4558
For a number of technical and logistical reasons, we need to commit UI build artefacts to the repo.

0 commit comments

Comments
 (0)