https://github.com/lxpio/omnigram
Omnigram is a Flutter-based file reader and audiobook . It accommodates EPUB and PDF and offers audiobook functionality, supporting TTS model and other AI chat technologies for enhanced reading experiences
https://github.com/lxpio/omnigram
chatbot epub flutter nas tts
Last synced: over 1 year ago
JSON representation
Omnigram is a Flutter-based file reader and audiobook . It accommodates EPUB and PDF and offers audiobook functionality, supporting TTS model and other AI chat technologies for enhanced reading experiences
- Host: GitHub
- URL: https://github.com/lxpio/omnigram
- Owner: lxpio
- Created: 2023-07-26T15:03:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T13:38:08.000Z (almost 2 years ago)
- Last Synced: 2024-09-13T01:47:28.210Z (almost 2 years ago)
- Topics: chatbot, epub, flutter, nas, tts
- Language: Dart
- Homepage: https://omnigram.lxpio.com
- Size: 7.03 MB
- Stars: 38
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
#
## About Omnigram
Omnigram is a multi-platform (iOS, Android, Web, Windows, Linux, Mac) file reading and audiobook client written in Flutter. It supports multiple formats, including EPUB and PDF. It provides audiobook functionality through TTS models and supports other AI models for assisted reading. In addition, it has local book management capabilities, allowing users to easily manage book storage on NAS. For its backend service deployment, refer to [omnigam-server](server/README.md). Or check the [official project documentation](https://omnigram.lxpio.com/).
## Features
- [x] Supports iOS and Android for EPUB ebook reading
- [x] Supports TTS text-to-speech, allows custom TTS engines
- [x] Supports local book management (NAS), including searching, reading, listening, notes, favorites, downloading, deleting books, settings, etc.
- [x] Supports conversational assistant with Markdown support, code block highlighting, conversation settings
- [x] Books support TTS reading using models
- [ ] Supports PDF, documents and other NAS content services management
- [ ] Supports Web, Windows, Linux, Mac
## Omnigram Infrastructure
## Official Documentation
You can find the official documentation (including installation manuals) at .
## Examples
For the mobile app, you can use https://omnigram-demo.lxpio.com:9443 for the Server Endpoint URL
```
The credential
email: admin
password: 123456
```
## For Dev
This project uses a three-way repository including:
- [riverpod](https://docs-v2.riverpod.dev/docs)
- [isar](https://isar.dev)
### Build
#### For Omnigram APP
```bash
git clone github.com/lxpio/omnigram.git
cd omnigram/app
make
```
#### For Omnigram Server
```bash
git clone github.com/lxpio/omnigram.git
cd omnigram/server
make
# make docker
```
### TTS Service
When the current App supports the FishTTS API Server, refer to [FishTTS](https://github.com/fishaudio/fish-speech).
```bash
git clone https://github.com/fishaudio/fish-speech.git
cd fish-speech
pip install -e .
python -m tools.api_server --listen 0.0.0.0:8999 --llama-checkpoint-path "checkpoints/fish-speech-1.5" --decoder-checkpoint-path "checkpoints/fish-speech-1.5/firefly-gan-vq-fsq-8x1024-21hz-generator.pth"
```
## Acknowledgments
This project makes extensive use of code from [Immich](https://github.com/immich-app/immich), and we thank them for their open-source contributions.
The creation of this project utilized three libraries, including:
- [riverpod](https://docs-v2.riverpod.dev/docs)
- [isar](https://isar.dev)
- [fish-speech](https://github.com/fishaudio/fish-speech)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details