HummingBirdAnimeClient/README.md

2.1 KiB

Hummingbird Anime Client

A self-hosted client that allows custom formatting of data from the hummingbird api

Build Status build status coverage report Scrutinizer Code Quality

[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 7.0+
  • PDO SQLite or PDO PostgreSQL (For collection tab)
  • GD
  • Redis or Memcached for caching

Installation

  1. Install via composer: composer create-project timw4mail/hummingbird-anime-client

or

  1. Install via git, then install dependencies via composer: composer install

  2. Duplicate app/config/*.toml.example files as app/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

    • public/js/cache
  5. Make sure the console script is executable

Using MAL API

  1. Update app/config/mal.toml with your username and password
  2. Enable MAL api in app/config/config.toml

Server Setup

See the wiki for more in-depth information