mirror of
https://github.com/tapframe/NuvioStreaming.git
synced 2026-01-11 20:10:25 +00:00
Revise README.md to streamline project description and features; update logo size, enhance clarity of setup instructions, and improve overall formatting for better readability. Remove outdated sections and focus on key functionalities of the Nuvio streaming app.
This commit is contained in:
tapframe
parent
0202c2da2d
commit
1c760ff5f0
1 changed files with 29 additions and 100 deletions
129
README.md
129
README.md
|
|
@ -1,33 +1,24 @@
|
|||
<p align="center">
|
||||
<img src="assets/titlelogo.png" alt="Nuvio Logo" width="400"/>
|
||||
<img src="assets/titlelogo.png" alt="Nuvio Logo" width="300"/>
|
||||
</p>
|
||||
|
||||
# Nuvio - Streaming App
|
||||
# Nuvio
|
||||
|
||||
Nuvio is an Open-Source cross-platform streaming application built with React Native and Expo, allowing users to browse, discover, and watch video content.
|
||||
An app I built with React Native/Expo for browsing and watching movies & shows. It uses Stremio-compatible addons to find streaming sources.
|
||||
|
||||
## ✨ Features
|
||||
Built for iOS and Android.
|
||||
|
||||
* **Home Screen:** Customizable dashboard featuring highlighted content, continue watching section, and access to various content catalogs.
|
||||
* **Content Discovery:** Explore trending, popular, or categorized movies and TV shows.
|
||||
* **Detailed Metadata:** Access comprehensive information for content, including descriptions, cast, crew, and ratings.
|
||||
* **Catalog Browsing:** Navigate through specific genres, curated lists, or addon-provided catalogs.
|
||||
* **Video Playback:** Integrated video player for watching content.
|
||||
* **Stream Selection:** Choose from available video streams provided by configured sources/addons.
|
||||
* **Search Functionality:** Search for specific movies, TV shows, or other content.
|
||||
* **Personal Library:** Manage a collection of favorite movies and shows.
|
||||
* **Trakt.tv Integration:** Sync watch history, collection, and watch progress with your Trakt account.
|
||||
* **Addon Management:** Install, manage, and reorder addons compatible with the Stremio addon protocol to source content streams and catalogs.
|
||||
* **Release Calendar:** View upcoming movie releases or TV show episode air dates.
|
||||
* **Extensive Settings:**
|
||||
* Player customization (e.g., subtitle preferences).
|
||||
* Content source configuration (TMDB API keys, MDBList URLs).
|
||||
* Catalog management and visibility.
|
||||
* Trakt account connection.
|
||||
* Notification preferences.
|
||||
* Home screen layout adjustments.
|
||||
* **Optimized & Interactive UI:** Smooth browsing with skeleton loaders, pull-to-refresh, performant lists, haptic feedback, and action menus.
|
||||
* **Cross-Platform:** Runs on iOS and Android (highly optimized for iOS; Android performance is generally good).
|
||||
## Key Features ✨
|
||||
|
||||
* **Home Screen:** Highlights new content, your watch history, and content categories.
|
||||
* **Discover:** Browse trending and popular movies & TV shows.
|
||||
* **Details:** Displays detailed info (descriptions, cast, ratings).
|
||||
* **Video Player:** Integrated player that remembers playback progress.
|
||||
* **Stream Finding:** Finds available streams using Stremio addons.
|
||||
* **Search:** Quickly find specific movies or shows.
|
||||
* **Trakt Sync:** Option to connect your Trakt.tv account.
|
||||
* **Addon Management:** Add and manage your Stremio addons.
|
||||
* **UI:** Focuses on a clean, interactive user experience.
|
||||
|
||||
## 📸 Screenshots
|
||||
|
||||
|
|
@ -37,87 +28,25 @@ Nuvio is an Open-Source cross-platform streaming application built with React Na
|
|||
| **Metadata** | **Seasons & Episodes** | **Rating** |
|
||||
|  | |  |
|
||||
|
||||
## 🚀 Tech Stack
|
||||
## Wanna run it? 🚀
|
||||
|
||||
* **Framework:** React Native (v0.76.9) with Expo (SDK 52)
|
||||
* **Language:** TypeScript
|
||||
* **Navigation:** React Navigation (v7)
|
||||
* **Video Playback:** `react-native-video`
|
||||
* **UI Components:** `react-native-paper`, `@gorhom/bottom-sheet`, `@shopify/flash-list`
|
||||
* **State Management/Async:** Context API, `axios`
|
||||
* **Animations & Gestures:** `react-native-reanimated`, `react-native-gesture-handler`
|
||||
* **Data Sources (Inferred):** TMDB (The Movie Database), potentially Stremio-related services
|
||||
1. You'll need Node.js, npm/yarn, and the Expo Go app (or native build tools like Android Studio/Xcode).
|
||||
2. `git clone https://github.com/nayifleo1/NuvioExpo.git`
|
||||
3. `cd NuvioExpo`
|
||||
4. `npm install` or `yarn install`
|
||||
5. `npx expo start` (Easiest way: Scan QR code with Expo Go app)
|
||||
* Or `npx expo run:android` / `npx expo run:ios` for native builds.
|
||||
|
||||
## 🛠️ Setup & Running
|
||||
## Found a bug or have an idea? 🐛
|
||||
|
||||
1. **Prerequisites:**
|
||||
* Node.js (LTS recommended)
|
||||
* npm or yarn
|
||||
* Expo Go app on your device/simulator (for development) or setup for native builds (Android Studio/Xcode).
|
||||
Great! Please open an [Issue on GitHub](https://github.com/nayifleo1/NuvioExpo/issues). Describe the problem or your suggestion.
|
||||
|
||||
2. **Clone the repository:**
|
||||
```bash
|
||||
git clone https://github.com/nayifleo1/NuvioExpo.git
|
||||
cd nuvio
|
||||
```
|
||||
## Want to contribute? 🤝
|
||||
|
||||
3. **Install dependencies:**
|
||||
```bash
|
||||
npm install
|
||||
# or
|
||||
yarn install
|
||||
```
|
||||
Contributions are welcome! Fork the repository, make your changes, and submit a Pull Request.
|
||||
|
||||
4. **Run the application:**
|
||||
---
|
||||
|
||||
* **For Expo Go (Development):**
|
||||
```bash
|
||||
npx expo start
|
||||
# or
|
||||
yarn dlx expo start
|
||||
```
|
||||
Scan the QR code with the Expo Go app on your iOS or Android device.
|
||||
Built with help from the communities and tools behind React Native, Expo, TMDB, Trakt, and the Stremio addon system.
|
||||
|
||||
* **For Native Android Build/Emulator:**
|
||||
```bash
|
||||
npx expo run:android
|
||||
# or
|
||||
yarn dlx expo run:android
|
||||
```
|
||||
|
||||
* **For Native iOS Build/Simulator:**
|
||||
```bash
|
||||
npx expo run:ios
|
||||
# or
|
||||
yarn dlx expo run:ios
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Contributions are welcome! If you'd like to contribute, please follow these general steps:
|
||||
|
||||
1. Fork the repository.
|
||||
2. Create a new branch for your feature or bug fix (`git checkout -b feature/your-feature-name` or `bugfix/issue-number`).
|
||||
3. Make your changes and commit them with descriptive messages.
|
||||
4. Push your branch to your fork (`git push origin feature/your-feature-name`).
|
||||
5. Open a Pull Request to the main repository's `main` or `develop` branch (please check which branch is used for development).
|
||||
|
||||
Please ensure your code follows the project's coding style and includes tests where applicable.
|
||||
|
||||
## 🐛 Reporting Issues
|
||||
|
||||
If you encounter any bugs or have suggestions, please open an issue on the GitHub repository. Provide as much detail as possible, including:
|
||||
|
||||
* Steps to reproduce the issue.
|
||||
* Expected behavior.
|
||||
* Actual behavior.
|
||||
* Screenshots or logs, if helpful.
|
||||
* Your environment (OS, device, app version).
|
||||
|
||||
## 🙏 Acknowledgements
|
||||
|
||||
Huge thanks to the Stremio team for their pioneering work in the streaming space and for creating their addon protocol/system. As an indie developer, their approach has been a major source of inspiration. This project utilizes compatibility with the Stremio addon ecosystem to source content.
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
||||
*Happy Streaming!*
|
||||
Loading…
Reference in a new issue