mirror of
https://github.com/tapframe/NuvioStreaming.git
synced 2026-05-10 12:01:55 +00:00
update Readme
This commit is contained in:
tapframe
parent
3b460ec63f
commit
2d4be20f72
1 changed files with 62 additions and 127 deletions
187
README.md
187
README.md
|
|
@ -5,198 +5,133 @@
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
A modern streaming app built with React Native and Expo, featuring Stremio addon integration, Trakt synchronization, and a beautiful user interface.
|
A cross‑platform streaming client built with React Native and Expo, featuring Stremio addon support and Trakt synchronization.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚠️ Beta Testing
|
## Status and Downloads
|
||||||
This app is currently in Beta testing. Please report any bugs or issues you encounter.
|
- This project is currently in Beta. Issues and PRs are welcome.
|
||||||
|
- Download: [Releases](https://github.com/tapframe/NuvioStreaming/tags)
|
||||||
[Download Latest Release](https://github.com/tapframe/NuvioStreaming/tags)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📱 Installation
|
## Installation
|
||||||
|
|
||||||
### AltStore Installation
|
### AltStore
|
||||||
<img src="https://upload.wikimedia.org/wikipedia/commons/2/20/AltStore_logo.png" width="32" height="32" align="left"> [](https://tinyurl.com/NuvioAltstore)
|
<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)
|
||||||
|
|
||||||
### SideStore Installation
|
### SideStore
|
||||||
<img src="https://github.com/SideStore/assets/blob/main/icon.png?raw=true" width="32" height="32" align="left"> [](https://tinyurl.com/NuvioSidestore)
|
<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)
|
||||||
|
|
||||||
**Manual URL:** `https://raw.githubusercontent.com/tapframe/NuvioStreaming/main/nuvio-source.json`
|
Manual source URL: `https://raw.githubusercontent.com/tapframe/NuvioStreaming/main/nuvio-source.json`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ✨ Key Features
|
## Core Capabilities
|
||||||
|
|
||||||
### 🎬 Content Discovery & Management
|
- **Streaming and Playback**
|
||||||
- **Smart Home Screen:** Personalized content recommendations and continue watching functionality
|
- Built‑in React Native Video player with gesture controls
|
||||||
- **Advanced Search:** Instant results with comprehensive filtering capabilities
|
- External player handoff for broader compatibility
|
||||||
- **Rich Metadata Display:** Detailed information, cast, crew, ratings, and similar content
|
- Subtitle selection and basic quality preferences
|
||||||
- **Calendar Integration:** Track upcoming episodes and releases with notification support
|
|
||||||
- **Library Management:** Personal collections with watch history and progress tracking
|
|
||||||
- **Cast & Crew Exploration:** Dedicated actor/director filmographies and detailed profiles
|
|
||||||
|
|
||||||
### 🎥 Streaming & Playbook
|
- **Discovery and Library**
|
||||||
- **Dual Video Player Support:**
|
- Search with filters and rich title/episode metadata
|
||||||
- Built-in React Native Video player with gesture controls
|
- Continue watching and progress tracking
|
||||||
- External player integration for enhanced compatibility
|
- Cast and crew details, similar titles
|
||||||
- Auto-quality selection and subtitle customization
|
|
||||||
- **Intelligent Stream Selection:** Automatically finds the best available quality
|
|
||||||
- **Trailer Integration:** Seamless trailer playback with preloading capabilities
|
|
||||||
- **Auto-Play Functionality:** Continuous episode watching experience
|
|
||||||
- **Progress Tracking:** Resume from where you left off across devices
|
|
||||||
|
|
||||||
### 🔗 Third-Party Integrations
|
- **Integrations**
|
||||||
- **Trakt.tv Synchronization:**
|
- Trakt: watch history, ratings, library sync (foreground and background)
|
||||||
- Complete watch history and rating sync
|
- Stremio addons: multiple content sources and addon management
|
||||||
- Library management and progress tracking
|
- TMDB: imagery and metadata; MDBList ratings support
|
||||||
- Auto-sync capabilities with background updates
|
- Local scraper provider support
|
||||||
- **Stremio Addon Ecosystem:**
|
|
||||||
- Full compatibility with Stremio addon system
|
|
||||||
- Easy addon management and installation
|
|
||||||
- Support for multiple content sources
|
|
||||||
- **TMDB Integration:** Comprehensive metadata and high-quality imagery
|
|
||||||
- **MDBList Support:** Additional ratings and personalized recommendations
|
|
||||||
- **Local Scraper System:** Custom content source integration
|
|
||||||
|
|
||||||
### 🎨 User Experience & Interface
|
- **UX and Performance**
|
||||||
- **Modern Material Design:** Clean, intuitive interface with smooth animations
|
- Modern UI with dynamic theming from artwork
|
||||||
- **Dynamic Theming:** Dominant color extraction for content-based UI theming
|
- Optimized image caching and list virtualization
|
||||||
- **Theme Customization:** Multiple color schemes and display preferences
|
- iOS and Android support
|
||||||
- **Optimized Performance:** Image caching and efficient list rendering
|
|
||||||
- **Cross-Platform Support:** Native experience on both iOS and Android
|
|
||||||
|
|
||||||
### 🔔 Smart Features
|
|
||||||
- **Push Notifications:** New episode alerts and personalized reminders
|
|
||||||
- **Background Sync:** Automatic data updates and content synchronization
|
|
||||||
- **Onboarding Experience:** Guided setup for new users
|
|
||||||
- **Comprehensive Settings:** Extensive customization options
|
|
||||||
- **Offline Functionality:** Robust caching system for improved performance
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📸 Screenshots
|
## Screenshots
|
||||||
|
|
||||||
| Home Screen | Details Page | Home Screen 2 |
|
| Home | Details | Library |
|
||||||
|:-----------:|:------------:|:-------------:|
|
|:----:|:-------:|:-------:|
|
||||||
|  |  |  |
|
|  |  |  |
|
||||||
|
|
||||||
| Library | Player Loading | Video Player |
|
Additional images are available in `screesnhots/`.
|
||||||
|:-------:|:--------------:|:------------:|
|
|
||||||
|  |  |  |
|
|
||||||
|
|
||||||
| Ratings | Episodes & Seasons | Search & Details |
|
|
||||||
|:-------:|:------------------:|:----------------:|
|
|
||||||
|  |  |  |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🧰 Tools & Technologies
|
## Tech Stack
|
||||||
|
- React Native, Expo, TypeScript
|
||||||
<p align="left">
|
- React Navigation, Reanimated/Gesture Handler
|
||||||
<a href="https://skillicons.dev">
|
- react-native-video, MMKV/AsyncStorage, FastImage
|
||||||
<img src="https://skillicons.dev/icons?i=react,typescript,nodejs,expo,github,githubactions&theme=light&perline=6" />
|
- Tooling: Metro, EAS, GitHub Actions
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Getting Started
|
## Development
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Node.js 18 or newer
|
- Node.js 18+
|
||||||
- npm or yarn
|
- npm or yarn
|
||||||
- Expo Go app (for development)
|
- Android Studio (Android) and/or Xcode (iOS)
|
||||||
- Android Studio (for Android builds)
|
|
||||||
- Xcode (for iOS builds)
|
|
||||||
|
|
||||||
### Development Setup
|
### Setup
|
||||||
1. Clone the repository:
|
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
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
# or
|
# or
|
||||||
yarn install
|
yarn install
|
||||||
```
|
```
|
||||||
|
3. Start development server:
|
||||||
3. Start the development server:
|
|
||||||
```bash
|
```bash
|
||||||
npx expo start
|
npx expo start
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Run on device/simulator:
|
4. Run on device/simulator:
|
||||||
- Scan QR code with Expo Go app
|
```bash
|
||||||
- Or run native builds:
|
npx expo run:android
|
||||||
```bash
|
# or
|
||||||
npx expo run:android
|
npx expo run:ios
|
||||||
# or
|
```
|
||||||
npx expo run:ios
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🤝 Contributing
|
## Contributing
|
||||||
|
Contributions are welcome. Please open an issue to discuss significant changes before submitting a PR.
|
||||||
We welcome contributions! Here's how you can help:
|
|
||||||
|
|
||||||
1. Fork the repository
|
|
||||||
2. Create your feature branch
|
|
||||||
3. Commit your changes
|
|
||||||
4. Push to the branch
|
|
||||||
5. Open a Pull Request
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🐛 Bug Reports & Feature Requests
|
## Support and Feedback
|
||||||
|
For bugs and feature requests, open an issue: `https://github.com/tapframe/NuvioStreaming/issues`
|
||||||
|
|
||||||
Found a bug or have an idea? Please open an [issue](https://github.com/tapframe/NuvioStreaming/issues) with:
|
Please include a clear description, reproduction steps, expected behavior, and screenshots if applicable.
|
||||||
- Clear description of the problem/suggestion
|
|
||||||
- Steps to reproduce (for bugs)
|
|
||||||
- Expected behavior
|
|
||||||
- Screenshots if applicable
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
## 📄 License
|
|
||||||
|
|
||||||
[](http://www.gnu.org/licenses/gpl-3.0.en.html)
|
[](http://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||||
|
|
||||||
This application is **free software**: you can use, study, share, and modify it as you wish.
|
This application is distributed under the [GNU GPLv3 or later](https://www.gnu.org/licenses/gpl.html).
|
||||||
|
|
||||||
It is distributed under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) version 3 or later, published by the Free Software Foundation.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚖️ DMCA Disclaimer
|
## Legal
|
||||||
|
- No content is hosted by this repository or the Nuvio application.
|
||||||
We hereby issue this notice to clarify that this application functions similarly to a standard web browser by fetching video files from the internet.
|
- Any content accessed is hosted by third‑party websites. Users are responsible for compliance with local laws.
|
||||||
|
- For takedown requests, contact the hosting providers, not the Nuvio developers.
|
||||||
- **No content is hosted by this repository or the Nuvio application.**
|
|
||||||
- Any content accessed is hosted by third-party websites.
|
|
||||||
- Users are solely responsible for their usage and must comply with their local laws.
|
|
||||||
|
|
||||||
If you believe content is violating copyright laws, please contact the **actual file hosts**, **not** the developers of this repository or the Nuvio app.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🙏 Acknowledgments
|
## Acknowledgments
|
||||||
|
|
||||||
Built with help from the amazing communities behind:
|
|
||||||
- React Native & Expo
|
- React Native & Expo
|
||||||
- TMDB API
|
- TMDB
|
||||||
- Trakt.tv
|
- Trakt.tv
|
||||||
- Stremio
|
- Stremio
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Thank You for using Nuvio!**
|
|
||||||
Loading…
Reference in a new issue