# akuse-app/akuse architecture

> Architecture diagram of the GitHub repository akuse-app/akuse, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/akuse-app/akuse
- Repository: https://github.com/akuse-app/akuse

## Overview

##### Main Components

a) Frontend Layer (Renderer Process):
- Main UI Components (src/renderer)
- Player Components
- Modal Components
- Tab System
- Styles and Animations

b) Backend Layer (Main Process):
- Electron Main Process
- IPC Communication
- Menu Management
- System Utilities

c) External Services:
- AniList API Integration
- Consumet API
- AniSkip API
- Aniwatch API
- Various Streaming Providers

##### Architecture Representation

**┌─────────────────────────────────────────────────────────────────┐**
- Electron Application                         │
- ┬──────────────────────────┬───────────────────┤
- Renderer Process│      IPC Bridge         │   Main Process    │
- (Frontend)     │                         │    (Backend)      │

- React UI    │   Preload Scripts      │  - Main Window    │
- Components  │   (src/main/preload.ts) │  - Menu Handler   │
- Video Player│                         │  - System Utils   │
- ┴──────────────────────────┴───────────────────┘
- ▲                                           ▲

- ▼                                           ▼
**┌─────────────────┐                    ┌─────────────────────────┐**
- API Services   │                    │   Streaming Providers    │
- AniList      │                    │   - Gogoanime           │
- AniSkip      │◄──────────────────►│   - HiAnime            │
- Aniwatch     │                    │   - AnimeUnity         │
- ┘                    │   - MonosChinos        │
- ┘

##### Key Architectural Patterns to Highlight

a) Electron's Two-Process Architecture:
- Clear separation between main and renderer processes
- IPC communication bridge

b) Module Organization:
- Provider System (src/modules/providers)
- AniList Integration (src/modules/anilist)
- Utility Modules (src/modules/utils)

c) Component Structure:
- Modal System
- Video Player Components
- Navigation System

##### Important Implementation Details

- Authentication Flow with AniList
- Video Player Integration
- Provider Selection System
- Multi-language Support
- Cache Management

##### Deployment Flow

- Packaging process
- Platform-specific builds (Windows/Linux)
- Auto-update mechanism

Remember to:
- Use a consistent visual language
- Notes for complex interactions
- Error handling paths
- Caching mechanisms
- Document security measures

This architecture should be represented in a way that clearly shows how the application maintains high performance while handling video streaming and API interactions, with proper error handling and fallback mechanisms for different providers.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Electron["Electron Application"]
        direction TB
        
        subgraph Frontend["Renderer Process (Frontend)"]
            direction TB
            UI["React UI Components"]:::frontend
            Player["Video Player System"]:::frontend
            Modals["Modal System"]:::frontend
            Tabs["Tab System"]:::frontend
            Nav["Navigation System"]:::frontend
            Styles["Global Styles"]:::frontend
            App["Main Application"]:::frontend
        end

        subgraph Bridge["IPC Bridge"]
            direction TB
            Preload["Preload Scripts"]:::bridge
        end

        subgraph Backend["Main Process (Backend)"]
            direction TB
            Main["Main Process"]:::backend
            Menu["Menu Management"]:::backend
            Utils["System Utilities"]:::backend
        end
    end

    subgraph External["External Services"]
        direction TB
        AniList["AniList API"]:::api
        AniSkip["AniSkip API"]:::api
        AniWatch["Aniwatch API"]:::api
    end

    subgraph Providers["Streaming Providers"]
        direction TB
        ProviderAPI["Provider API System"]:::provider
        ProviderCache["Provider Cache"]:::provider
        Gogo["GogoAnime"]:::provider
        HiAnime["HiAnime"]:::provider
        AnimeUnity["AnimeUnity"]:::provider
    end

    %% Connections
    UI --> Player
    UI --> Modals
    UI --> Tabs
    UI --> Nav
    UI --> Styles
    App --> UI

    Frontend <--> Preload
    Preload <--> Backend

    Backend <--> External
    Backend <--> Providers

    ProviderAPI --> ProviderCache
    ProviderAPI --> Gogo
    ProviderAPI --> HiAnime
    ProviderAPI --> AnimeUnity

    %% Click Events
    click Main "https://github.com/akuse-app/akuse/blob/react-port/src/main/main.ts"
    click Menu "https://github.com/akuse-app/akuse/blob/react-port/src/main/menu.ts"
    click Preload "https://github.com/akuse-app/akuse/blob/react-port/src/main/preload.ts"
    click UI "https://github.com/akuse-app/akuse/tree/react-port/src/renderer/components/"
    click Player "https://github.com/akuse-app/akuse/tree/react-port/src/renderer/components/player/"
    click Modals "https://github.com/akuse-app/akuse/tree/react-port/src/renderer/components/modals/"
    click Tabs "https://github.com/akuse-app/akuse/tree/react-port/src/renderer/tabs/"
    click AniList "https://github.com/akuse-app/akuse/blob/react-port/src/modules/anilist/anilistApi.ts"
    click AniSkip "https://github.com/akuse-app/akuse/blob/react-port/src/modules/aniskip.ts"
    click Gogo "https://github.com/akuse-app/akuse/blob/react-port/src/modules/providers/gogoanime.ts"
    click HiAnime "https://github.com/akuse-app/akuse/blob/react-port/src/modules/providers/hianime.ts"
    click AnimeUnity "https://github.com/akuse-app/akuse/blob/react-port/src/modules/providers/animeunity.ts"
    click ProviderAPI "https://github.com/akuse-app/akuse/blob/react-port/src/modules/providers/api.ts"
    click ProviderCache "https://github.com/akuse-app/akuse/blob/react-port/src/modules/providers/cache.ts"
    click App "https://github.com/akuse-app/akuse/blob/react-port/src/renderer/App.tsx"
    click Nav "https://github.com/akuse-app/akuse/blob/react-port/src/renderer/MainNavbar.tsx"
    click Styles "https://github.com/akuse-app/akuse/blob/react-port/src/styles/style.css"

    %% Styles
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef backend fill:#2ecc71,stroke:#27ae60,color:white
    classDef bridge fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef api fill:#e67e22,stroke:#d35400,color:white
    classDef provider fill:#9b59b6,stroke:#8e44ad,color:white
```
