mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
75 lines
3.6 KiB
Markdown
75 lines
3.6 KiB
Markdown
# Contributing to the Frontend
|
||
|
||
# InvokeAI Web UI
|
||
|
||
- [InvokeAI Web UI](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#invokeai-web-ui)
|
||
- [Stack](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#stack)
|
||
- [Contributing](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#contributing)
|
||
- [Dev Environment](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#dev-environment)
|
||
- [Production builds](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#production-builds)
|
||
|
||
The UI is a fairly straightforward Typescript React app, with the Unified Canvas being more complex.
|
||
|
||
Code is located in `invokeai/frontend/web/` for review.
|
||
|
||
## Stack
|
||
|
||
State management is Redux via [Redux Toolkit](https://github.com/reduxjs/redux-toolkit). We lean heavily on RTK:
|
||
|
||
- `createAsyncThunk` for HTTP requests
|
||
- `createEntityAdapter` for fetching images and models
|
||
- `createListenerMiddleware` for workflows
|
||
|
||
The API client and associated types are generated from the OpenAPI schema. See API_CLIENT.md.
|
||
|
||
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).
|
||
|
||
[Chakra-UI](https://github.com/chakra-ui/chakra-ui) & [Mantine](https://github.com/mantinedev/mantine) for components and styling.
|
||
|
||
[Konva](https://github.com/konvajs/react-konva) for the canvas, but we are pushing the limits of what is feasible with it (and HTML canvas in general). We plan to rebuild it with [PixiJS](https://github.com/pixijs/pixijs) to take advantage of WebGL's improved raster handling.
|
||
|
||
[Vite](https://vitejs.dev/) for bundling.
|
||
|
||
Localisation is via [i18next](https://github.com/i18next/react-i18next), but translation happens on our [Weblate](https://hosted.weblate.org/engage/invokeai/) project. Only the English source strings should be changed on this repo.
|
||
|
||
## Contributing
|
||
|
||
Thanks for your interest in contributing to the InvokeAI Web UI!
|
||
|
||
We encourage you to ping @psychedelicious and @blessedcoolant on [Discord](https://discord.gg/ZmtBAhwWhy) if you want to contribute, just to touch base and ensure your work doesn't conflict with anything else going on. The project is very active.
|
||
|
||
### Dev Environment
|
||
|
||
**Setup**
|
||
|
||
1. Install [node](https://nodejs.org/en/download/). You can confirm node is installed with:
|
||
```bash
|
||
node --version
|
||
```
|
||
2. Install [yarn classic](https://classic.yarnpkg.com/lang/en/) and confirm it is installed by running this:
|
||
```bash
|
||
npm install --global yarn
|
||
yarn --version
|
||
```
|
||
|
||
From `invokeai/frontend/web/` run `yarn install` to get everything set up.
|
||
|
||
Start everything in dev mode:
|
||
1. Ensure your virtual environment is running
|
||
2. Start the dev server: `yarn dev`
|
||
3. Start the InvokeAI Nodes backend: `python scripts/invokeai-web.py # run from the repo root`
|
||
4. Point your browser to the dev server address e.g. [http://localhost:5173/](http://localhost:5173/)
|
||
|
||
### VSCode Remote Dev
|
||
|
||
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:
|
||
|
||
`ssh -L 9090:localhost:9090 -L 5173:localhost:5173 user@host`
|
||
|
||
### Production builds
|
||
|
||
For a number of technical and logistical reasons, we need to commit UI build artefacts to the repo.
|
||
|
||
If you submit a PR, there is a good chance we will ask you to include a separate commit with a build of the app.
|
||
|
||
To build for production, run `yarn build`. |