diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f229e831 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [Year] [Copyright Holder Name] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index da5e86d3..f7d653d7 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,107 @@ -# 🎬 NUVIO Streaming App 🎬 +# Nuvio - Streaming App -A modern, beautiful streaming application built with React Native and Expo. +Nuvio is an Open-Source cross-platform streaming application built with React Native and Expo, allowing users to browse, discover, and watch video content. ## ✨ Features -- 🚀 Fast, responsive UI with smooth animations -- 🎥 Stream movies and TV shows with ease -- 🔍 Powerful search functionality -- 📚 Organize your media in a personal library -- 📱 Cross-platform (iOS and Android) -- 🌙 Beautiful dark mode interface -- 🧩 Add-on system for extensibility -- 📅 Calendar for upcoming releases -- 📺 Video player with quality selection +* **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:** Configure and manage Stremio-like addons 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). -## 📱 Screenshots +## 🚀 Tech Stack -*Coming soon!* +* **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 -## 🛠️ Tech Stack +## 🛠️ Setup & Running -- React Native -- Expo -- TypeScript -- React Navigation -- React Native Paper -- Expo Linear Gradient -- Expo Vector Icons +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). -## 📋 Requirements +2. **Clone the repository:** + ```bash + git clone https://github.com/nayifleo1/NuvioExpo.git + cd nuvio + ``` -- Node.js 14+ -- Expo CLI -- Android Studio (for Android development) -- Xcode (for iOS development, macOS only) +3. **Install dependencies:** + ```bash + npm install + # or + yarn install + ``` -## 🚀 Getting Started +4. **Run the application:** -1. Clone the repository: -```bash -git clone https://github.com/nayifleo1/NuvioExpo.git -cd NuvioExpo -``` + * **For Expo Go (Development):** + ```bash + npm start + # or + yarn start + ``` + Scan the QR code with the Expo Go app on your iOS or Android device. -2. Install dependencies: -```bash -npm install -``` + * **For Native Android Build/Emulator:** + ```bash + npm run android + # or + yarn android + ``` -3. Start the development server: -```bash -npx expo start -``` - -4. Run on your preferred platform: - - Press `a` for Android - - Press `i` for iOS (requires macOS) - - Scan the QR code with Expo Go on your device - -## 🌟 Key Components - -- **Home Screen**: Discover trending and recommended content -- **Discover Screen**: Browse through categories and genres -- **Library Screen**: Access your saved and watched content -- **Add-ons Screen**: Manage streaming sources -- **Settings Screen**: Customize your experience - -## 🔮 Future Plans - -- ⚡ Performance optimizations -- 🔐 User authentication -- 💾 Offline viewing -- 📢 Push notifications for new content -- 🌐 Multi-language support + * **For Native iOS Build/Simulator:** + ```bash + npm run ios + # or + yarn ios + ``` ## 🤝 Contributing -Contributions, issues, and feature requests are welcome! +Contributions are welcome! If you'd like to contribute, please follow these general steps: -## 📝 License +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). -This project is licensed under the MIT License - see the LICENSE file for details. +Please ensure your code follows the project's coding style and includes tests where applicable. -## 🙏 Acknowledgements +## 🐛 Reporting Issues -Special thanks to all the open-source libraries and tools that made this project possible. +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). -Built with ❤️ by the NUVIO team \ No newline at end of file +## 📄 License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. \ No newline at end of file