Skip to content

Repository files navigation

Icon

Akari

GitHub Actions Workflow Status GitHub commit activity Version License

Akari is a high-quality, open-source manga reader built with Tanstack Start. It provides an enhanced reading experience, allowing users to manage bookmarks and reading history seamlessly.

Table of Contents

Features

Reader Experience

  • Enhanced Reading Interface: Clean, modern UI optimized for manga reading
  • Multiple View Modes: Support for both individual page reading for manga and list reading for manhwa
  • Responsive Design: Fully responsive interface that works on mobile and desktop

Manga Management

  • Genre Filtering: Browse manga by specific genres
  • Popular Manga Section: Discover trending and popular manga
  • Latest Updates: Stay informed about newly added chapters

Bookmarks and Sync

  • External Service Integration: Sync with MyAnimeList (MAL) and AniList accounts to import your saved manga
  • Bookmark Management: Save, organize, and track your favorite manga titles with up-to-date chapter progress

Settings

General

Setting Default Description
Theme System Select the application theme.
Fancy Animations Enabled Such as manga detail pages cover image.
Show Toasts Enabled Show toast notifications for various actions.
Login Toasts Disabled Show warnings when you aren't logged in to a service.
Allow Analytics Enabled Allow the collection of anonymous analytics data.

Manga

Setting Default Description
Page Display Type Auto Select the default reader type for manga.
Show Page Progress Enabled Shows a progress bar at the side/ bottom when reading.
Strip Reader Width 144 Width of the strip reader.
Reading Direction Left to Right Select the reading direction for manga.
Advance chapter on last page Enabled Automatically advance to the next chapter when reaching the last page.

Shortcuts

Setting Default Description
Show Shortcuts Enabled Enable or disable keyboard shortcuts.
Search Manga Mod+K Shortcut to search manga.
Toggle Sidebar Mod+B Shortcut to toggle the sidebar.
Open Settings Mod+, Shortcut to open settings.
Open Account Mod+. Shortcut to open account page.
Navigate to Bookmarks Mod+Shift+B Shortcut to navigate to bookmarks.
Next Page ArrowRight
Previous Page ArrowLeft

Getting Started

Local Installation

If you prefer to run Akari locally, follow these steps. Your akari account will not be available if running locally.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/sn0w12/Akari
    cd Akari
  2. Configure environment variables:

    Create a .env file in the root directory by copying the example file:

    cp .env.example .env

    Edit .env and configure the following variables:

    Required:

    • VITE_API_URL - The API endpoint for fetching manga content.

    Optional:

    • VITE_HOST - Your website host (e.g., akari.mydomain.com) used for metadata
    • VITE_ANI_CLIENT_ID - AniList client ID for AniList integration
    • VITE_MAL_CLIENT_ID - MyAnimeList client ID for MAL integration
    • VITE_PLAUSIBLE_ENDPOINT - Your Plausible Analytics endpoint (e.g., https://plausible.yourdomain.com/api/event)
    • DISABLE_STATIC_GENERATION - Set to 1 to disable static generation (default: 0)
    • GENERATE_SITEMAP - Set to 1 to enable sitemap generation (default: 0)
    • VITE_VAPID_PUBLIC_KEY - VAPID public key for web push notifications
    • VITE_SUPABASE_URL - Supabase URL for account functionality
    • VITE_SUPABASE_PUBLISHABLE_OR_ANON_KEY - Supabase publishable/anon key for accounts
  3. Install dependencies:

    npm install
  4. Start the development server:

    npm run dev

Open http://localhost:3000 in your browser to view the application.

Production Build

To build for production:

npm run build
npm run start

Screenshots

Front Page

FrontPage

Bookmarks

Bookmarks

Manga

Manga

Author

Author

Genre

Genre

Disclaimer

This project is provided for learning and educational purposes.

Akari is not functional out of the box without the user supplying their own data, services, and configuration where required.

About

Akari is a manga reader built with tanstack start

Topics

Resources

Stars

27 stars

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages