API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Timothy Warren dcc5b928c7 Merge remote-tracking branch 'origin/develop' 4 months ago
app Use images directly from Kitsu for the rest of the views 4 months ago
build Remove old CodeIgniter style sniffs, as it is not being used 6 months ago
frontEndSrc Update more views to use images directly from Kitsu 4 months ago
migrations Collection updates for 'all' tab 2 years ago
public Remove now unused image caching directories 4 months ago
src Use images directly from Kitsu for the rest of the views 4 months ago
tests Update broken tests 4 months ago
.editorconfig Some progress toward better structure through refactoring 7 years ago
.gitignore Fix build issue with phpstan 1 year ago
.htaccess Update htaccess so images can load 5 years ago
.travis.yml Lots of little code fixes, hides notices shown on PHP 8.1 6 months ago
CHANGELOG.md Use image builder class to simplify createPlaceholderImage 4 months ago
Jenkinsfile Attempt to fix Jenkins build, again 7 months ago
LICENSE Add license 5 years ago
README.md Update docs and CI 1 year ago
composer.json Update and streamline dependencies 6 months ago
console Use image builder class to simplify createPlaceholderImage 4 months ago
index.php Code style fixes 4 months ago
phinx.yml.dist Add migration to create a link table between anime_sets and media 2 years ago
phpdoc.dist.xml Fix some documentation generation issues 4 years ago
phpdox.xml Cleanup some build/quality check stuff 2 years ago
phpstan.neon Fix build issue with phpstan 1 year ago
phpunit.xml Fix tests for PHP8...? 1 year ago
sw.js Fix generic user page route, minor code cleanup 4 years ago

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