matthias/open-appui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
10 commits 2 branches 0 tags 426 KiB
  • Dart 76.2%
  • C++ 11.3%
  • CMake 8.9%
  • Ruby 1.2%
  • Swift 1.1%
  • Other 1.2%
Find a file
Exact
Yui ffa55745ea Update README with improved notes and affiliation info 
Replaces the plain note about the dev-submodules directory with a formatted note, and moves the project affiliation disclaimer to the end with improved formatting. Clarifies that OpenAppUI is independent from Open WebUI.
2025-08-14 11:20:42 +02:00
.github Add community and contribution guidelines 2025-08-14 11:14:31 +02:00
android Init basic flutter app 2025-08-12 12:48:55 +02:00
dev-submodules chore: add open-webui as submodule under dev-submodules/open-webui 2025-08-14 11:17:39 +02:00
ios Update README with improved notes and affiliation info 2025-08-14 11:20:42 +02:00
lib Add account settings and improve chat reopen features 2025-08-14 11:02:42 +02:00
linux Add settings, admin, and archived chats screens 2025-08-12 16:54:03 +02:00
macos Add settings, admin, and archived chats screens 2025-08-12 16:54:03 +02:00
test Add account settings and improve chat reopen features 2025-08-14 11:02:42 +02:00
web Init basic flutter app 2025-08-12 12:48:55 +02:00
windows Add settings, admin, and archived chats screens 2025-08-12 16:54:03 +02:00
.gitattributes Init basic flutter app 2025-08-12 12:48:55 +02:00
.gitignore Add settings, admin, and archived chats screens 2025-08-12 16:54:03 +02:00
.gitmodules Init basic flutter app 2025-08-12 12:48:55 +02:00
.metadata Init basic flutter app 2025-08-12 12:48:55 +02:00
analysis_options.yaml Init basic flutter app 2025-08-12 12:48:55 +02:00
CODE_OF_CONDUCT.md Add community and contribution guidelines 2025-08-14 11:14:31 +02:00
CONTRIBUTING.md Add community and contribution guidelines 2025-08-14 11:14:31 +02:00
devtools_options.yaml Implement chat title autogeneration and UI improvements 2025-08-14 10:11:08 +02:00
pubspec.lock Add settings, admin, and archived chats screens 2025-08-12 16:54:03 +02:00
pubspec.yaml Add settings, admin, and archived chats screens 2025-08-12 16:54:03 +02:00
README.md Update README with improved notes and affiliation info 2025-08-14 11:20:42 +02:00
SECURITY.md Add community and contribution guidelines 2025-08-14 11:14:31 +02:00

README.md

OpenAppUI

OpenAppUI is a cross‑platform Flutter client for interacting with an Open WebUI backend.

  • Platforms: Android, iOS, macOS, Windows, Linux, Web
  • Tech: Flutter, Riverpod, GoRouter, Material Design 3
  • Backend: Any reachable Open WebUI server (self‑hosted or remote)

Note

The dev-submodules/ directory (in case you clone with submodules) (including dev-submodules/open-webui) is for development convenience only. It is not part of the application and is not required to build or run OpenAppUI.

Prerequisites

  • Flutter (stable) with Dart SDK ≥ 3.7.2
  • A running Open WebUI backend you can reach from your device/emulator

Quick start

git clone https://github.com/sleepyyui/open-appui
cd open-appui
flutter pub get
flutter run

On first launch, set the backend Base URL in‑app when prompted (or via Settings). Example: https://your-webui.example.com.

Build for a platform

  • Android: flutter build apk or flutter build appbundle
  • iOS: flutter build ios (requires Xcode setup)
  • macOS: flutter build macos
  • Windows: flutter build windows
  • Linux: flutter build linux
  • Web: flutter build web

Refer to Flutter’s platform setup guides as needed.

Configuration

OpenAppUI stores the backend Base URL and session token securely on device. There are no required compile‑time flags; all configuration is done within the app. You can change the Base URL later in Settings.

Development

  • Use Material Design 3 components and theming.
  • Run checks locally:
    • Analyze: flutter analyze
    • Tests: flutter test

See CONTRIBUTING.md for the full contribution guide.

Contributing

We welcome issues and PRs! Please read:

  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md

Security

Please do not file public issues for security matters. See SECURITY.md for private disclosure instructions.

Acknowledgements

Important

OpenAppUI is an independent project and is not affiliated with, endorsed by, or sponsored by the Open WebUI project or its maintainers. The projects are separate and unrelated entities. References to Open WebUI in this repository are solely for interoperability and descriptive purposes.