{"id":13454584,"url":"https://github.com/lxpio/omnigram","last_synced_at":"2025-03-24T06:31:00.346Z","repository":{"id":184574385,"uuid":"671111295","full_name":"lxpio/omnigram","owner":"lxpio","description":"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","archived":false,"fork":false,"pushed_at":"2024-09-12T13:38:08.000Z","size":7367,"stargazers_count":38,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-13T01:47:28.210Z","etag":null,"topics":["chatbot","epub","flutter","nas","tts"],"latest_commit_sha":null,"homepage":"https://omnigram.lxpio.com","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lxpio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-26T15:03:40.000Z","updated_at":"2024-09-12T13:38:12.000Z","dependencies_parsed_at":"2023-08-20T05:15:24.478Z","dependency_job_id":"b70a724b-ea54-4940-9aaf-9f0c9fc61948","html_url":"https://github.com/lxpio/omnigram","commit_stats":null,"previous_names":["exppii/omnigram","nexptr/omnigram","lxpio/omnigram"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lxpio%2Fomnigram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lxpio%2Fomnigram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lxpio%2Fomnigram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lxpio%2Fomnigram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lxpio","download_url":"https://codeload.github.com/lxpio/omnigram/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245222352,"owners_count":20580138,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","epub","flutter","nas","tts"],"created_at":"2024-07-31T08:00:55.608Z","updated_at":"2025-03-24T06:31:00.320Z","avatar_url":"https://github.com/lxpio.png","language":"Dart","funding_links":[],"categories":["Dart"],"sub_categories":[],"readme":"#\n\n\u003cpicture\u003e\n  \u003csource\n    srcset=\"./docs/static/img/logo_with_letter_dark.svg\"\n    media=\"(prefers-color-scheme: dark)\"\n  /\u003e\n  \u003csource\n    srcset=\"./docs/static/img/logo_with_letter_white.svg\"\n    media=\"(prefers-color-scheme: light), (prefers-color-scheme: no-preference)\"\n  /\u003e\n  \u003cimg src=\"./docs/static/img/logo_with_letter_white.svg\" /\u003e\n\u003c/picture\u003e\n\n\u003cdiv style=\"font-size: 1.5rem;\"\u003e\n  \u003ca href=\"./README.md\"\u003eEnglish\u003c/a\u003e | \u003ca href=\"./README.zh.md\"\u003e中文\u003c/a\u003e\n\u003c/div\u003e\n\u003c/br\u003e\n\n![docs action](https://github.com/lxpio/omnigram/actions/workflows/docs.yaml/badge.svg) \n![docs action](https://github.com/lxpio/omnigram/actions/workflows/docker.yaml/badge.svg) \n![docs action](https://github.com/lxpio/omnigram/actions/workflows/build_app.yaml/badge.svg)\n\n## About Omnigram\n\nOmnigram 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/).\n\n## Features\n\n- [x] Supports iOS and Android for EPUB ebook reading\n- [x] Supports TTS text-to-speech, allows custom TTS engines\n- [x] Supports local book management (NAS), including searching, reading, listening, notes, favorites, downloading, deleting books, settings, etc.\n- [x] Supports conversational assistant with Markdown support, code block highlighting, conversation settings\n- [x] Books support TTS reading using models\n- [ ] Supports PDF, documents and other NAS content services management\n- [ ] Supports Web, Windows, Linux, Mac\n\n## Omnigram Infrastructure\n\n![base_struct](docs/static/img/struct.svg)\n\n## Official Documentation\n\nYou can find the official documentation (including installation manuals) at \u003chttps://omnigram.lxpio.com/\u003e.\n\n## Examples\n\nFor the mobile app, you can use https://omnigram-demo.lxpio.com:9443 for the Server Endpoint URL\n\n```\nThe credential\nemail: admin\npassword: 123456\n```\n\n\n## For Dev\n\nThis project uses a three-way repository including:\n\n- [riverpod](https://docs-v2.riverpod.dev/docs)\n- [isar](https://isar.dev)\n\n### Build\n\n#### For Omnigram APP \n\n```bash\n\ngit clone github.com/lxpio/omnigram.git\ncd omnigram/app\nmake\n```\n\n#### For Omnigram Server\n\n```bash\n\ngit clone github.com/lxpio/omnigram.git\ncd omnigram/server\nmake \n\n# make docker \n```\n\n\n### TTS Service\n\nWhen the current App supports the FishTTS API Server, refer to [FishTTS](https://github.com/fishaudio/fish-speech).\n\n```bash\ngit clone https://github.com/fishaudio/fish-speech.git\ncd fish-speech\n\npip install -e .\npython -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\"\n```\n\n## Acknowledgments\n\nThis project makes extensive use of code from [Immich](https://github.com/immich-app/immich), and we thank them for their open-source contributions.\n\nThe creation of this project utilized three libraries, including:\n\n- [riverpod](https://docs-v2.riverpod.dev/docs)\n- [isar](https://isar.dev)\n- [fish-speech](https://github.com/fishaudio/fish-speech)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flxpio%2Fomnigram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flxpio%2Fomnigram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flxpio%2Fomnigram/lists"}