Skip to content

README.md

Latest commit

 

History

History
79 lines (55 loc) · 2.42 KB

README.md

File metadata and controls

79 lines (55 loc) · 2.42 KB
Raw

AgOpenWeb

Cross-platform agricultural GPS guidance — a rewrite of AgOpenGPS using HTML/JS, Avalonia, .NET 10, and C#. The UI is a web page served up by the backend host.

Download & run

Grab the latest build from the Releases page. Everything is a self-contained app (no .NET install needed). Pick the set that matches how you'll run it — in every mode the host also serves http://<host>:5174 on the LAN, so cab phones/tablets connect in a browser.

🖥️ Desktop — a window with the guidance UI (host runs in-process):

OS Download Run
Windows x64 agopenweb-win-x64.zip run AgOpenWeb.Desktop.exe
macOS (Apple silicon) agopenweb-macos-arm64.dmg drag to Applications, launch
Linux x64 / arm64 agopenweb-launcher-linux-<arch>.tar.gz ./run.sh

🛰️ Headless (Linux + Windows) — no window; UI in a browser at http://<host>:5174, auto-starts on boot (for an in-cab mini-PC / SBC):

OS Download Install
Linux x64 / arm64 agopenweb-linux-<arch>.tar.gz sudo ./install.sh --from app (systemd)
Windows x64 agopenweb-win-x64.zip install-service.cmd → Run as administrator (Windows Service)

📱 Mobile — all-in-one (host + UI on the device):

Device Download Install
Android agopenweb-android.apk sideload

Each download's bundled README lists the prerequisites (e.g. the WebView2 Runtime on Windows, WebKitGTK on Linux).

Platforms

  • Windows x64
  • macOS x64 / ARM64
  • Linux x64 / ARM64
  • Android
  • iOS (sideload)

Tech stack

  • UI: Avalonia 12
  • MVVM: CommunityToolkit.Mvvm
  • Runtime: .NET 10
  • Architecture: MVVM with dependency injection; ~92% shared cross-platform code
  • Testing: NUnit, Avalonia.Headless

Building from source

Prerequisites: .NET 10 SDK

# Desktop (Windows/macOS/Linux)
dotnet build Platforms/AgOpenWeb.Desktop
dotnet run --project Platforms/AgOpenWeb.Desktop

# Android
dotnet build Platforms/AgOpenWeb.Android

# Run tests
dotnet test

See BUILD.md for platform-specific setup, and deploy/{linux,windows,macos}/ for the packaging scripts that produce the release bundles above.

Contributing

See CONTRIBUTING.md for the architecture overview, feature list, and how to get started.

License

GNU General Public License v3.0