API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy J. Warren cb23807348
Some checks failed
timw4mail/HummingBirdAnimeClient/pipeline/head There was a failure building this commit
Fix other old Kitsu url references
2024-08-13 07:56:20 -04:00
app Fix other old Kitsu url references 2024-08-13 07:56:20 -04:00
build Move new helper functions to a more logical place, fix UserTransformer test 2023-05-19 10:42:25 -04:00
frontEndSrc Update frontend minification config and dependencies 2024-02-15 15:21:26 -05:00
migrations Reformat misc files 2022-03-03 18:19:02 -05:00
public Update frontend minification config and dependencies 2024-02-15 15:21:26 -05:00
src Fix other old Kitsu url references 2024-08-13 07:56:20 -04:00
tests Fix other old Kitsu url references 2024-08-13 07:56:20 -04:00
tools Update header comments 2023-07-13 11:08:05 -04:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Set up a proper formatter for more consistent code style 2022-03-03 17:26:09 -05:00
.htaccess Update htaccess so images can load 2017-04-28 13:20:59 -04:00
.php-cs-fixer.dist.php Some minor code style fixes 2023-07-13 11:06:52 -04:00
.travis.yml Lots of little code fixes, hides notices shown on PHP 8.1 2021-12-02 16:06:34 -05:00
CHANGELOG.md Add anilist example config file, and make the interface a bit more helpful 2023-07-13 14:17:51 -04:00
composer.json Vastly simplify logic for getting a user's anime library. Most basic API functionality seems to be working 2023-10-26 16:00:13 -04:00
console Use image builder class to simplify createPlaceholderImage 2022-01-07 19:57:07 -05:00
index.php Update header comments 2023-07-13 11:08:05 -04:00
Jenkinsfile Update CI to use several PHP versions 2023-12-21 13:49:54 -05:00
justfile Update tooling and config 2023-05-19 16:34:07 -04:00
LICENSE Add license 2017-01-27 16:34:03 -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 Update tooling and config 2023-05-19 16:34:07 -04:00
phpunit.xml Fix tests for PHP8...? 2020-12-11 14:26:54 -05:00
README.md add php extensions required to README.md 2023-06-28 18:37:44 +00:00
sw.js Fix generic user page route, minor code cleanup 2018-11-07 14:29:21 -05:00
testRoutes.php Update header comments 2023-07-13 11:08:05 -04:00

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.2
    • ext-dom (For editing the DOM)
    • ext-gd (For caching images)
    • ext-intl (For time localization)
    • ext-json
    • ext-mbstring
    • ext-pdo
  • 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