mirror of
https://github.com/tapframe/NuvioStreaming.git
synced 2026-05-10 20:10:54 +00:00
update readme
This commit is contained in:
parent
2d4be20f72
commit
2f784e3b22
1 changed files with 92 additions and 76 deletions
168
README.md
168
README.md
|
|
@ -1,137 +1,153 @@
|
||||||
# Nuvio Streaming App
|
# Nuvio Streaming App
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="assets/titlelogo.png" alt="Nuvio Logo" width="300"/>
|
<img src="assets/titlelogo.png" alt="Nuvio Logo" width="300"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
A cross‑platform streaming client built with React Native and Expo, featuring Stremio addon support and Trakt synchronization.
|
A modern streaming application built with React Native and Expo, featuring comprehensive Stremio addon integration and Trakt.tv synchronization.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Status and Downloads
|
## ⚠️ Beta Release
|
||||||
- This project is currently in Beta. Issues and PRs are welcome.
|
This application is currently in beta. Please report any issues you encounter.
|
||||||
- Download: [Releases](https://github.com/tapframe/NuvioStreaming/tags)
|
|
||||||
|
[Download Latest Release](https://github.com/tapframe/NuvioStreaming/tags)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## 📱 Installation
|
||||||
|
|
||||||
### AltStore
|
### AltStore Installation
|
||||||
<img src="https://upload.wikimedia.org/wikipedia/commons/2/20/AltStore_logo.png" width="16" height="16" align="left"> [Add to AltStore](https://tinyurl.com/NuvioAltstore)
|
<img src="https://upload.wikimedia.org/wikipedia/commons/2/20/AltStore_logo.png" width="32" height="32" align="left"> [](https://tinyurl.com/NuvioAltstore)
|
||||||
|
|
||||||
### SideStore
|
### SideStore Installation
|
||||||
<img src="https://github.com/SideStore/assets/blob/main/icon.png?raw=true" width="16" height="16" align="left"> [Add to SideStore](https://tinyurl.com/NuvioSidestore)
|
<img src="https://github.com/SideStore/assets/blob/main/icon.png?raw=true" width="32" height="32" align="left"> [](https://tinyurl.com/NuvioSidestore)
|
||||||
|
|
||||||
Manual source URL: `https://raw.githubusercontent.com/tapframe/NuvioStreaming/main/nuvio-source.json`
|
**Manual URL:** `https://raw.githubusercontent.com/tapframe/NuvioStreaming/main/nuvio-source.json`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Core Capabilities
|
## ✨ Core Features
|
||||||
|
|
||||||
- **Streaming and Playback**
|
### 🎬 Content Discovery
|
||||||
- Built‑in React Native Video player with gesture controls
|
- **Personalized Recommendations:** Smart home screen with continue watching functionality
|
||||||
- External player handoff for broader compatibility
|
- **Advanced Search:** Comprehensive filtering and instant search results
|
||||||
- Subtitle selection and basic quality preferences
|
- **Rich Metadata:** Detailed content information, cast, crew, and ratings
|
||||||
|
- **Calendar Integration:** Track upcoming episodes and releases
|
||||||
|
- **Library Management:** Personal collections with watch history tracking
|
||||||
|
|
||||||
- **Discovery and Library**
|
### 🎥 Streaming Experience
|
||||||
- Search with filters and rich title/episode metadata
|
- **Dual Player Support:** Built-in video player with gesture controls and external player integration
|
||||||
- Continue watching and progress tracking
|
- **Intelligent Quality Selection:** Automatic stream optimization and subtitle support
|
||||||
- Cast and crew details, similar titles
|
- **Trailer Playback:** Seamless trailer integration with preloading
|
||||||
|
- **Continuous Playback:** Auto-play functionality for uninterrupted viewing
|
||||||
|
- **Progress Synchronization:** Resume playback across devices
|
||||||
|
|
||||||
- **Integrations**
|
### 🔗 Platform Integrations
|
||||||
- Trakt: watch history, ratings, library sync (foreground and background)
|
- **Trakt.tv Sync:** Complete watch history, ratings, and library synchronization
|
||||||
- Stremio addons: multiple content sources and addon management
|
- **Stremio Ecosystem:** Full addon compatibility with easy management
|
||||||
- TMDB: imagery and metadata; MDBList ratings support
|
- **TMDB Integration:** Comprehensive metadata and high-quality imagery
|
||||||
- Local scraper provider support
|
- **MDBList Support:** Enhanced ratings and recommendations
|
||||||
|
- **Custom Scrapers:** Local content source integration
|
||||||
|
|
||||||
- **UX and Performance**
|
### 🎨 User Interface
|
||||||
- Modern UI with dynamic theming from artwork
|
- **Material Design:** Clean, modern interface with smooth animations
|
||||||
- Optimized image caching and list virtualization
|
- **Dynamic Theming:** Content-based color extraction and customization
|
||||||
- iOS and Android support
|
- **Cross-Platform:** Native experience on iOS and Android
|
||||||
|
- **Performance Optimized:** Efficient rendering and image caching
|
||||||
|
|
||||||
|
### 🔔 Advanced Features
|
||||||
|
- **Push Notifications:** New episode alerts and content reminders
|
||||||
|
- **Background Synchronization:** Automatic data updates and content sync
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Screenshots
|
## 📸 Screenshots
|
||||||
|
|
||||||
| Home | Details | Library |
|
| Home Screen | Details Page | Home Screen 2 |
|
||||||
|:----:|:-------:|:-------:|
|
|:-----------:|:------------:|:-------------:|
|
||||||
|  |  |  |
|
|  |  |  |
|
||||||
|
|
||||||
Additional images are available in `screesnhots/`.
|
| Library | Player Loading | Video Player |
|
||||||
|
|:-------:|:--------------:|:------------:|
|
||||||
|
|  |  |  |
|
||||||
|
|
||||||
|
| Ratings | Episodes & Seasons | Search & Details |
|
||||||
|
|:-------:|:------------------:|:----------------:|
|
||||||
|
|  |  |  |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Tech Stack
|
## 🧰 Tools & Technologies
|
||||||
- React Native, Expo, TypeScript
|
|
||||||
- React Navigation, Reanimated/Gesture Handler
|
<p align="left">
|
||||||
- react-native-video, MMKV/AsyncStorage, FastImage
|
<a href="https://skillicons.dev">
|
||||||
- Tooling: Metro, EAS, GitHub Actions
|
<img src="https://skillicons.dev/icons?i=react,typescript,nodejs,expo,github,githubactions&theme=light&perline=6" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Development
|
## 🛠️ Development
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Node.js 18+
|
- Node.js 18+
|
||||||
- npm or yarn
|
- npm or yarn
|
||||||
- Android Studio (Android) and/or Xcode (iOS)
|
- Expo CLI
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
1. Clone the repository:
|
```bash
|
||||||
```bash
|
git clone https://github.com/tapframe/NuvioStreaming.git
|
||||||
git clone https://github.com/tapframe/NuvioStreaming.git
|
cd NuvioStreaming
|
||||||
cd NuvioStreaming
|
npm install
|
||||||
```
|
npx expo start
|
||||||
2. Install dependencies:
|
```
|
||||||
```bash
|
|
||||||
npm install
|
### Build Commands
|
||||||
# or
|
```bash
|
||||||
yarn install
|
npx expo run:android # Android build
|
||||||
```
|
npx expo run:ios # iOS build
|
||||||
3. Start development server:
|
```
|
||||||
```bash
|
|
||||||
npx expo start
|
|
||||||
```
|
|
||||||
4. Run on device/simulator:
|
|
||||||
```bash
|
|
||||||
npx expo run:android
|
|
||||||
# or
|
|
||||||
npx expo run:ios
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Contributing
|
## 🤝 Contributing
|
||||||
Contributions are welcome. Please open an issue to discuss significant changes before submitting a PR.
|
|
||||||
|
1. Fork the repository
|
||||||
|
2. Create a feature branch
|
||||||
|
3. Make your changes
|
||||||
|
4. Submit a pull request
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Support and Feedback
|
## 🐛 Issues
|
||||||
For bugs and feature requests, open an issue: `https://github.com/tapframe/NuvioStreaming/issues`
|
|
||||||
|
|
||||||
Please include a clear description, reproduction steps, expected behavior, and screenshots if applicable.
|
Report bugs and request features via [GitHub Issues](https://github.com/tapframe/NuvioStreaming/issues)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[](http://www.gnu.org/licenses/gpl-3.0.en.html)
|
|
||||||
|
|
||||||
This application is distributed under the [GNU GPLv3 or later](https://www.gnu.org/licenses/gpl.html).
|
## 📄 License
|
||||||
|
|
||||||
|
[](http://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||||
|
|
||||||
|
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Legal
|
## ⚖️ Disclaimer
|
||||||
- No content is hosted by this repository or the Nuvio application.
|
|
||||||
- Any content accessed is hosted by third‑party websites. Users are responsible for compliance with local laws.
|
This application functions as a content aggregator, accessing publicly available streams from third-party sources. No media content is hosted by this application. Users are responsible for compliance with applicable laws and regulations.
|
||||||
- For takedown requests, contact the hosting providers, not the Nuvio developers.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Acknowledgments
|
## 🙏 Acknowledgments
|
||||||
|
|
||||||
|
Built with support from:
|
||||||
- React Native & Expo
|
- React Native & Expo
|
||||||
- TMDB
|
- TMDB API
|
||||||
- Trakt.tv
|
- Trakt.tv
|
||||||
- Stremio
|
- Stremio
|
||||||
Loading…
Reference in a new issue