Skip to content

Commit 50a5f13

Browse files
Initial README for Client ElectronJS Application
1 parent 5457929 commit 50a5f13

3 files changed

Lines changed: 16 additions & 6 deletions

File tree

Assets/ClientApplication.png

136 KB
Loading

Assets/ClientSendingMessage.png

295 KB
Loading

Client/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1-
# Vue 3 + Typescript + Vite
1+
# Client ElectronJS Desktop Application
2+
This is the [ElectronJS](https://www.electronjs.org/) Desktop Application for the Client built using [VueJS](https://vuejs.org/) and [Typescript](https://www.typescriptlang.org).
23

3-
This template should help get you started developing with Vue 3 and Typescript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
4+
The Client uses the Node.js UDP Datagram to communicate with the Switcher and send messages across the network of Routers to another another Client.
45

5-
## Recommended IDE Setup
6+
## Installation
7+
```bash
8+
npm install
69

7-
- [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)
10+
# Start the Electron Application
11+
npm run electron:dev
812

9-
## Type Support For `.vue` Imports in TS
13+
# Build for production
14+
npm run app:build
15+
```
16+
## Application
17+
![Client Application](../Assets/ClientApplication.png)
18+
This application is started when the Client process is created. The Client attempts to connect to the Switcher and if successful, it will be allocated an IP address and port dependent on the network and available ports.
1019

11-
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's `.vue` type support plugin by running `Volar: Switch TS Plugin on/off` from VSCode command palette.
20+
### Sending Messages
21+
![Client Sending Messag](../Assets/ClientSendingMessage.png)

0 commit comments

Comments
 (0)