ollama-app/README.md

48 lines
2.5 KiB
Markdown

# Ollama App
A modern and easy-to-use client for Ollama. Have the greatest experience while keeping everything private and in your local network.
| ![banner 1: home screen](assets/screenshots/flutter_24.png) | ![banner 2: model selector](assets/screenshots/flutter_15.png) | ![banner 3: sample message](assets/screenshots/flutter_18.png) | ![banner 4: opened sidebar](assets/screenshots/flutter_26.png) |
|-|-|-|-|
> [!IMPORTANT]
> This app does not host a Ollama server on device, but rather connects to one and uses its api endpoint.
> You don't know what Ollama is? Learn more at [ollama.com](https://ollama.com/).
## Getting Started
Ollama App has a pretty simple and intuitive interface to be as open as possible. Everything just works out of the but, you just have to follow the two next steps.
### Installation
You'll find the latest recommended version of the Ollama App under [the releases tab](https://github.com/JHubi1/ollama-app/releases). Download the APK and install it on your Android device. That's it, now proceed to [Initial Setup](#initial-setup).
Alternatively, you can also download the app from any of the following stores:
[<img src="assets/stores/IzzyOnDroid.png" width="215" style="padding: 5px" />](https://apt.izzysoft.de/fdroid/index/apk/com.freakurl.apps.ollama/)
### Setup
The most difficult part is setting up the host. To learn more visit the [wiki guide on how to do so](https://github.com/JHubi1/ollama-app/wiki/Getting-Started#setting-up-the-host). After setting up, you normally don't have to enter it again.
And you're done! Just start chatting with your local AI and have fun!
> [!TIP]
> The new Voice Mode is now avaliable as an experimental feature. Learn more about it in [the documentation](https://github.com/JHubi1/ollama-app/wiki/Components#voice).
## Documentation
The documentation for components, functions, etc. has moved to the [Wiki Page](https://github.com/JHubi1/ollama-app/wiki) of this repository. These steps there will be updated with future versions.
## Translations and Contribution
You want to help me make this project even better? Great, help is always appresheated.
Ollama App is created using [Flutter](https://flutter.dev), a modern and robust frontend framework designed to make a single codebase run on multiple target platforms. The framework itself is based on the [Dart](https://dart.dev) programming language.
Read more in the [Contribution Guide](https://github.com/JHubi1/ollama-app/wiki/Contributing).
## Star History
![Star History Chart](https://api.star-history.com/svg?repos=JHubi1/ollama-app&type=Timeline)