diff --git a/invokeai/frontend/web/docs/README.md b/invokeai/frontend/web/docs/README.md index a8f8b7e7b0..138aded3ab 100644 --- a/invokeai/frontend/web/docs/README.md +++ b/invokeai/frontend/web/docs/README.md @@ -1,79 +1,51 @@ -# InvokeAI Web UI +# Invoke UI -- [InvokeAI Web UI](#invokeai-web-ui) +- [Invoke UI](#invoke-ui) - [Core Libraries](#core-libraries) - - [Redux Toolkit](#redux-toolkit) - - [Socket\.IO](#socketio) - - [Chakra UI](#chakra-ui) - - [KonvaJS](#konvajs) - - [Vite](#vite) - - [i18next & Weblate](#i18next--weblate) - - [openapi-typescript](#openapi-typescript) - - [reactflow](#reactflow) - - [zod](#zod) - - [Client Types Generation](#client-types-generation) - [Package Scripts](#package-scripts) + - [Client Types Generation](#client-types-generation) - [Contributing](#contributing) + - [Localization](#localization) - [Dev Environment](#dev-environment) - - [VSCode Remote Dev](#vscode-remote-dev) - - [Production builds](#production-builds) + - [VSCode Remote Dev](#vscode-remote-dev) -The UI is a fairly straightforward Typescript React app. - ## Core Libraries -InvokeAI's UI is made possible by a number of excellent open-source libraries. The most heavily-used are listed below, but there are many others. +Invoke's UI is made possible by a number of excellent open-source libraries. The most heavily-used are listed below, but there are many others. -### Redux Toolkit +- [Redux Toolkit] +- [redux-remember] +- [Socket.IO] +- [Chakra UI] +- [KonvaJS] +- [Vite] +- [openapi-typescript] +- [reactflow] +- [zod] -[Redux Toolkit] is used for state management and fetching/caching: +## Package Scripts -- `RTK-Query` for data fetching and caching -- `createAsyncThunk` for a couple other HTTP requests -- `createEntityAdapter` to normalize things like images and models -- `createListenerMiddleware` for async workflows +See `package.json` for all scripts. -We use [redux-remember] for persistence. +Run with `pnpm