improve types

This commit is contained in:
Anton Bracke
2022-02-22 12:02:56 +01:00
parent d03544c839
commit 71c8e32b2f
16 changed files with 105 additions and 121 deletions
+9 -9
View File
@@ -1,23 +1,23 @@
# Desktop app
The desktop component is an electron app. It uses a hybrid setup based of two main components:
- A `local-app` bundled into the electron app. It has two main parts:
The desktop component is an electron app inside `./electron/`. It uses a hybrid setup based of two main components:
- A `local-app` bundled into the electron app with two main parts:
- A sidebar to show the server list, with the currently selected server
- A main page which is used to manage servers and to show other "local" pages like the options
- A main page which is used to manage servers and to show other "local" pages like the desktop-app settings
- A BrowserView (often called `appView` or `app`) showing the actual frontend of an external WorkAdventure deployment.
If a server is selected the BrowserView / `appView` is overlaying the main part right to the sidebar.
If a server is selected the BrowserView / `appView` is overlaying the whole main part right to the sidebar.
## Development
```bash
# start local-app
yarn dev:local-app
# start local-app in watch mode
cd local-app && yarn dev
# start electron app
LOCAL_APP_URL=http://localhost:3000 yarn dev
# start electron app in watch mode
cd electron && LOCAL_APP_URL=http://localhost:3000 yarn dev
# or create an executable by running:
yarn bundle
cd electron && yarn bundle
```
## API for front