API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy Warren 70d5519d22
timw4mail/HummingBirdAnimeClient/pipeline/head This commit looks good Details
Attempt to fix Jenkins build, again
2021-10-07 21:51:29 -04:00
app Drastically simplify setup for bundling js files 2021-04-23 18:58:51 -04:00
build Test Type classes 2021-02-23 15:38:29 -05:00
frontEndSrc Fix build issue with phpstan 2021-04-23 19:22:45 -04:00
migrations Collection updates for 'all' tab 2020-04-30 15:33:16 -04:00
public Drastically simplify setup for bundling js files 2021-04-23 18:58:51 -04:00
src Make some anime detail pages more robust 2021-10-07 21:45:17 -04:00
tests Misc fixes 2021-02-26 14:42:07 -05:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Fix build issue with phpstan 2021-04-23 19:22:45 -04:00
.htaccess Update htaccess so images can load 2017-04-28 13:20:59 -04:00
.travis.yml Update CI to PHP 8 2021-02-03 09:52:18 -05:00
CHANGELOG.md Update docs and CI 2021-02-05 17:19:11 -05:00
Jenkinsfile Attempt to fix Jenkins build, again 2021-10-07 21:51:29 -04:00
LICENSE Add license 2017-01-27 16:34:03 -05:00
README.md Update docs and CI 2021-02-05 17:19:11 -05:00
composer.json Replace Whoops with Tracy 2021-02-23 17:08:36 -05:00
console A few minor fixes 2021-02-18 12:48:59 -05:00
index.php Misc fixes 2021-02-26 14:42:07 -05:00
phinx.yml.dist Add migration to create a link table between anime_sets and media 2020-04-22 17:52:07 -04:00
phpdoc.dist.xml Fix some documentation generation issues 2018-01-10 16:24:00 -05:00
phpdox.xml Cleanup some build/quality check stuff 2020-03-13 09:53:31 -04:00
phpstan.neon Fix build issue with phpstan 2021-04-23 19:22:45 -04:00
phpunit.xml Fix tests for PHP8...? 2020-12-11 14:26:54 -05:00
sw.js Fix generic user page route, minor code cleanup 2018-11-07 14:29:21 -05:00

README.md

Hummingbird Anime Client

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

Build Status Build Status

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

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