📃 Updates documentation with a guide

This commit is contained in:
Rune Harlyk
2024-05-28 18:44:47 +02:00
committed by Rune Harlyk
parent c9ccb914bf
commit 869614fedb
18 changed files with 194 additions and 312 deletions
+39
View File
@@ -0,0 +1,39 @@
# Developing
> *Prerequsition*: You have successfully build, flashed and configured your robot.
## Setting up SvelteKit
### Proxy Configuration for Development
Configure the proxy settings in the `vite.config.ts` file to direct API calls to your ESP32 device. By default it used the factory MDNS address, but can be changed to the ip if preferred.
```ts
server: {
proxy: {
'/api': {
target: 'http://spot-micro.local', // Here
changeOrigin: true,
ws: true
},
'/ws': {
target: 'ws://spot-micro.local', // Here
changeOrigin: true,
ws: true
}
}
},
```
Changes require a restart of the development server.
### Start the Development Server
Use the following commands to launch the development server with Vite, enabling instant updates:
```sh
cd app
pnpm run dev
```
Access the frontend via the provided browser link.