matt/meshai
1
0
Fork 0
mirror of https://github.com/zvx-echo6/meshai.git synced 2026-08-26 17:31:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(readme): move frontend-build note to root README

Browse source 
work/README.md is about to become a symlink to root README.md on
docs/single-readme. Retarget the frontend-build documentation added in
56eba0f7 from work/README.md to root README.md so it isn't silently
dropped when that symlink lands.
This commit is contained in:
Matt Johnson 2026-07-17 03:00:58 +00:00
commit 8d60db11d6
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -71,11 +71,17 @@ As you save settings, MeshAI persists them back into `/data` as focused per-doma
```bash
git clone https://github.com/zvx-echo6/meshai.git
cd meshai/work
cd dashboard-frontend && npm ci && npm run build && cd .. # builds the web dashboard — required, see note
pip install -e .
cp config.example.yaml config.yaml # minimal starting point, not exhaustive — see note below
meshai
```
> **The frontend build step is required.** `meshai/dashboard/static/` is no longer
> committed to the repo, so skipping it means no dashboard UI is served (the bot and
> API still run fine). Docker users don't need this — the image builds the frontend
> automatically. Requires Node.js/npm.
Unlike Docker, `meshai` won't create a config file for you — it needs one to exist before it will start. `config.example.yaml` bootstraps the basics (connection, LLM backend, bot behavior); once it's running, open `http://localhost:8080` and use the dashboard for everything else.
> **Note on `config.example.yaml`:** it documents the legacy single-file schema and is no longer complete — it predates `coverage`, `danger_zones`, `generic_sources`, `meshcore_context`, `commands`, and the current 8-family notification-routing model (`notifications.toggles` / `destinations` / `region_routes`). The legacy single-file loader still works and is fully supported, but the dashboard — backed by the full config schema — is the authoritative way to reach every setting. Don't treat this file as a complete reference.

6
work/README.md
View file

@ -55,17 +55,11 @@ Everything is driven from the web UI, organized into **General**, **Meshtastic**
```bash
git clone https://github.com/zvx-echo6/meshai.git
cd meshai
cd dashboard-frontend && npm ci && npm run build && cd .. # builds the web dashboard -- required, see note below
pip install -e .
cp config.example.yaml config.yaml # then edit config.yaml (or use the dashboard)
meshai
```
> The frontend build step is required. `meshai/dashboard/static/` is no longer
> committed to the repo, so skipping it means no dashboard UI is served (the
> bot and API still run fine). Docker users don't need this -- the image
> builds the frontend automatically. Requires Node.js/npm.
Or with Docker:
```bash