timw4mail/hummingbird-anime-client

A self-hosted anime/manga client for Kitsu.

v5.2.0 2023-07-13 16:28 UTC

Requires

• php: >= 8.1.0
• ext-dom: *
• ext-gd: *
• ext-intl: *
• ext-json: *
• ext-mbstring: *
• ext-pdo: *
• amphp/http-client: ^4.5.0
• aura/html: ^2.5.0
• aura/router: ^3.1.0
• aura/session: ^2.1.0
• aviat/banker: ^4.1.2
• aviat/query: ^4.1.0
• laminas/laminas-diactoros: ^3.0.0
• laminas/laminas-httphandlerrunner: ^2.6.1
• maximebf/consolekit: ^1.0.3
• monolog/monolog: ^3.0.0
• psr/http-message: ^1.0.1
• symfony/polyfill-mbstring: ^1.0.0
• symfony/polyfill-util: ^1.0.0
• tracy/tracy: ^2.8.0
• yosymfony/toml: ^1.0.4

Requires (Dev)

• phpstan/phpstan: ^1.2.0
• phpunit/phpunit: ^10.0.0
• roave/security-advisories: dev-master
• spatie/phpunit-snapshot-assertions: ^5.0.1

MIT

• Timothy J. Warren

README

Update your anime/manga list on Kitsu.io and Anilist

[Hosted Example]

Features

• Anime List views (Each with list and cover views):

  • Watching
  • Plan to Watch
  • On Hold
  • Dropped
  • Completed
  • Combined View

• Manga List views (Each with list and cover views):

  • Reading
  • Plan to Read
  • On Hold
  • Dropped
  • Completed
  • Combined View

• Anime collection view (segmented by media type):

  • Cover Images
  • Table List

Requirements

• PHP 8.2
  • ext-dom (For editing the DOM)
  • ext-gd (For caching images)
  • ext-intl (For time localization)
  • ext-json
  • ext-mbstring
  • ext-pdo

Highly Recommended

• Redis or Memcached for caching
• PDO SQLite or PDO PostgreSQL (For collection tab)

Installation

1. Install via git, then install dependencies via composer: composer install
2. Duplicate app/config/config.toml.example file as app/config/config.toml
3. Configure settings in app/config/config.toml to your liking
4. Create the following directories if they don't exist, and make sure they are world writable
   • app/config
   • app/logs
   • public/images/avatars
   • public/images/anime
   • public/images/characters
   • public/images/manga
5. Make sure the console script is executable
6. Additional settings are on the settings page once you log in.

Server Setup

See the wiki for more in-depth information