andry/EMS-ESP32
1
0
Fork 0
mirror of https://github.com/emsesp/EMS-ESP32.git synced 2026-01-26 08:39:09 +03:00
Code Issues Packages Projects Releases Wiki Activity

make reference to emsesp docs

Browse Source
This commit is contained in:
proddy
2026-01-11 13:13:40 +01:00
parent 03ec96bf96
commit 5fe4b315f3
1 changed files with 1 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
mock-api/README.md
View File

@@ -1,13 +1 @@
When developing and testing the web interface, it's handy not to bother with re-flashing an ESP32 each time. The idea is to mimic the ESP using a mock/stub server that responds to the REST (HTTP POST & GET) and WebSocket calls.
# prerequisites
- Install the latest LTS of NodeJS
- install corepack `npm install -g corepack@latest` and `orepack enable`
- Install pnpm (`corepack use pnpm@latest-10` on linux or `winget install -e --id pnpm.pnpm` on windows). See <https://pnpm.io/installation>
- Install bun (<https://bun.sh/docs/installation>)
- type `pnpm install` from this `mock-api` folder to build
# To run
- `pnpm standalone` from the main `interface` folder and then navigate to <http://localhost:3000>
Refer to the [EMS-ESP documentation](https://emsesp.org/Building#webui-development) on how to run the mock Web server.