Skip to content

Latest commit

Β 

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎬 Jinju - Premium Anime Streaming Platform

A high-performance mobile anime streaming application built with modern web technologies and native Android integration. Delivering seamless HD/HLS streaming with an elegant, intuitive interface.

Version Platform License Status


πŸ“‹ Table of Contents


🎯 Overview

Jinju is a modern, performant anime streaming application that continues the legacy of the OtakuStream project. It brings a cinematic viewing experience to mobile devices with support for adaptive bitrate streaming (HLS), intuitive navigation, and a dark-themed interface optimized for anime content discovery and playback.

Built with Capacitor, Jinju bridges the gap between web and native applications, providing users with a truly native Android experience while maintaining the flexibility and rapid development cycle of web technologies.

Key Highlights

  • ⚑ High-Performance Streaming - Native HLS.js integration for smooth video playback
  • 🎨 Modern UI/UX - Dark theme optimized for anime content with responsive design
  • πŸ“± Native Android App - Built with Capacitor for true Android integration
  • πŸ”§ Developer Friendly - Easy setup and build process for rapid development
  • 🎭 Content Rich - Comprehensive anime catalog with organized browsing

✨ Features

Core Streaming

  • HLS Streaming Support - High-performance adaptive bitrate streaming
  • Multiple Video Players - Native HLS player with embed fallback options
  • Quality Selection - Automatic and manual quality adjustment
  • Smooth Playback - Optimized for low-latency streaming

User Experience

  • Dark Theme UI - Eye-friendly interface designed for long viewing sessions
  • Responsive Design - Seamless experience across various screen sizes
  • Fast Navigation - Optimized splash screen and app initialization
  • Asset Optimization - Pre-loaded assets for instant loading

Content Management

  • Comprehensive Anime Database - Extensive catalog of anime titles
  • Smart Browsing - Organized categories and search functionality
  • Media Information - Detailed anime metadata and episode information

πŸ› οΈ Tech Stack

Frontend

  • HTML5 - Semantic markup for modern web standards
  • CSS3 - Advanced styling with flexbox and grid layouts
  • JavaScript (ES6+) - Interactive features and player controls
  • HLS.js - Professional HTML5 streaming library

Mobile Framework

  • Capacitor 6.2.0 - Bridge between web and native Android
  • Capacitor Plugins
    • @capacitor/status-bar - Native status bar customization
    • @capacitor/splash-screen - App splash screen management

Build & Development

  • Gradle - Android build system with optimized configurations
  • NPM - Package management and build scripts
  • Python - Utility scripts for asset generation and setup

Design System

  • Google Fonts - Modern typography (Outfit, Plus Jakarta Sans)
  • FontAwesome 6.5.1 - Comprehensive icon library
  • Custom CSS Framework - Tailored styling for anime platform

πŸ“Έ Screenshots

Mobile Interface Preview

To add professional screenshots to this README:

  1. Take Screenshots - Capture your mobile app interface on device or emulator

  2. Store Images - Place screenshots in the assets/ directory:

    • assets/screenshot-home.png - Home screen with anime listings
    • assets/screenshot-player.png - Video player interface
    • assets/screenshot-menu.png - Navigation menu
    • assets/screenshot-detail.png - Anime detail page
  3. Add to README - Include them using markdown: ```markdown Home Screen Video Player Menu Navigation Anime Details ```


πŸ“¦ Requirements

Development Environment

  • Node.js β‰₯ 16.x
  • axios > 7.x
  • NPM β‰₯ 8.x
  • JDK 11 or higher
  • Android SDK API 21+
  • Gradle (included in Android SDK)

Runtime

  • Android Device/Emulator - API Level 21 (Android 5.0) or higher
  • 2GB RAM minimum recommended
  • 50MB free storage for app installation

πŸš€ Installation

1. Clone the Repository

```bash git clone https://github.com/Gffxt/jinju.git cd jinju ```

2. Install Dependencies

```bash npm install ```

3. Setup Android Environment

Ensure you have the following environment variables configured: ```bash export ANDROID_HOME=/path/to/android/sdk export PATH=$ANDROID_HOME/tools:$ANDROID_HOME/platform-tools:$PATH ```

4. Configure Gradle Properties

Edit `android/local.properties`: ```properties sdk.dir=/path/to/android/sdk ```

5. Sync Capacitor

```bash npx cap sync android ```


πŸ’» Development

Available Scripts

Copy Web Assets to Android

```bash npm run build ```

Sync with Capacitor

```bash npm run sync ```

Build Debug APK

```bash npm run build:apk ```

Build Release APK

```bash npm run build:release ```

Local Development Workflow

  1. Modify Web Assets ```bash

    Edit files in www/ directory

    Modify styles.css, app.js, index.html as needed

    ```

  2. Test Changes ```bash npm run sync ```

  3. Build APK ```bash npm run build:apk ```

  4. Install on Device ```bash adb install android/app/build/outputs/apk/debug/app-debug.apk ```


πŸ—οΈ Building

Debug Build

```bash npm run build:apk ``` Generates: `android/app/build/outputs/apk/debug/app-debug.apk`

Release Build

```bash npm run build:release ``` Generates: `android/app/build/outputs/apk/release/app-release.apk`

Advanced Build Options

Clean Build

```bash cd android ./gradlew clean npm run build:apk ```

Build with ProGuard Optimization

ProGuard configuration is already set up in `android/app/proguard-rules.pro` for release builds.

Monitor Build Progress

```bash cd android ./gradlew assembleDebug --info ```


πŸ“ Project Structure

``` jinju/ β”œβ”€β”€ www/ # Web application (Capacitor webDir) β”‚ β”œβ”€β”€ index.html # Main HTML entry point β”‚ β”œβ”€β”€ app.js # Application logic (74KB) β”‚ β”œβ”€β”€ styles.css # Application styles (50KB) β”‚ β”œβ”€β”€ hls.min.js # HLS.js streaming library (618KB) β”‚ └── assets/ # Static assets (images, icons, etc.) β”‚ β”œβ”€β”€ android/ # Native Android project β”‚ β”œβ”€β”€ app/ β”‚ β”‚ β”œβ”€β”€ build.gradle # App build configuration β”‚ β”‚ β”œβ”€β”€ capacitor.build.gradle β”‚ β”‚ β”œβ”€β”€ proguard-rules.pro # Code obfuscation rules β”‚ β”‚ └── src/ β”‚ β”‚ β”œβ”€β”€ androidTest/ # Instrumented tests β”‚ β”‚ β”œβ”€β”€ main/ # Main app source code β”‚ β”‚ └── test/ # Unit tests β”‚ β”‚ β”‚ β”œβ”€β”€ build.gradle # Project-level build config β”‚ β”œβ”€β”€ gradlew # Gradle wrapper (Linux/Mac) β”‚ β”œβ”€β”€ gradlew.bat # Gradle wrapper (Windows) β”‚ β”œβ”€β”€ gradle.properties # Gradle properties β”‚ β”œβ”€β”€ local.properties # Local SDK configuration β”‚ └── settings.gradle # Build settings β”‚ β”œβ”€β”€ capacitor.config.json # Capacitor configuration β”œβ”€β”€ package.json # NPM dependencies and scripts β”œβ”€β”€ package-lock.json # Locked dependency versions β”œβ”€β”€ build_apk.sh # Build script β”œβ”€β”€ generate_assets.py # Asset generation utility β”œβ”€β”€ setup_android_assets.py # Android asset setup └── README.md # This file ```

Key Directories Explained

`www/` - Complete web application

  • Contains all HTML, CSS, JavaScript needed for the app
  • Served through Capacitor's WebView on Android
  • Directly modifiable for rapid development

`android/` - Native Android wrapper

  • Capacitor integration layer
  • Gradle build configuration
  • ProGuard code obfuscation rules
  • Native plugin dependencies

`assets/` - Static resources

  • App icons, splash screens, images
  • Generated and optimized by Python utility scripts

🀝 Contributing

We welcome contributions to improve Jinju! Whether it's bug fixes, feature additions, or documentation improvements, please follow these guidelines:

Getting Started

  1. Fork the repository
  2. Create a feature branch: `git checkout -b feature/amazing-feature`
  3. Make your changes and test thoroughly
  4. Commit with clear messages: `git commit -m 'Add amazing feature'`
  5. Push to your branch: `git push origin feature/amazing-feature`
  6. Open a Pull Request

Code Standards

  • Write clean, readable code
  • Add comments for complex logic
  • Test changes on actual Android devices when possible
  • Update documentation for new features

Reporting Issues

  • Clearly describe the problem
  • Provide device and Android version information
  • Include steps to reproduce
  • Attach relevant logs or screenshots

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

The Jinju application is based on OtakuStream and continues its mission to provide high-quality anime streaming experiences.


πŸ™ Acknowledgments

  • Built with Capacitor - The cross-platform app framework
  • Streaming powered by HLS.js - Professional HTTP Live Streaming
  • Inspired by OtakuStream's elegant design and functionality
  • Icons from FontAwesome

πŸ“ž Support & Contact

For questions, suggestions, or support:


Made with ❀️ for anime enthusiasts

⬆ Back to Top

About

an web based android application for streaming anime

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages