API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy Warren 6e16632988 Revert "Will tests still work with fewer file priviledges?"
This reverts commit 14db3f1ec9.
2020-03-16 15:23:19 -04:00
app Update all the header comments 2020-03-11 15:15:05 -04:00
build Cleanup some build/quality check stuff 2020-03-13 09:53:31 -04:00
migrations Rough start of Manga collection...need to set up proper structure for manga collection items 2017-09-14 16:18:13 -04:00
public Update detail pages to use one column for text 2019-08-10 10:07:28 -04:00
src Fix some style issues 2020-03-16 15:06:55 -04:00
tests Cleanup some build/quality check stuff 2020-03-13 09:53:31 -04:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Various code style tweaks 2019-12-09 13:13:31 -05:00
.htaccess Update htaccess so images can load 2017-04-28 13:20:59 -04:00
.travis.yml Another attempt to fix CI 2020-03-12 10:24:21 -04:00
CHANGELOG.md Bump PHP requirement 2020-03-11 15:14:34 -04:00
Jenkinsfile Revert "Will tests still work with fewer file priviledges?" 2020-03-16 15:23:19 -04:00
LICENSE Add license 2017-01-27 16:34:03 -05:00
README.md Bump PHP requirement 2020-03-11 15:14:34 -04:00
RoboFile.php Cleanup some build/quality check stuff 2020-03-13 09:53:31 -04:00
composer.json Cleanup some build/quality check stuff 2020-03-13 09:53:31 -04:00
console Clean up commands a little bit 2019-07-11 19:03:35 -04:00
index.php Increase code coverage 2020-03-12 12:04:20 -04:00
phinx.yml Update phinx.yml file for new version of Phinx, see #20 2019-01-07 14:31:17 -05: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 More refactoring/cleanup 2019-12-09 16:17:25 -05:00
phpunit.xml Really ugly progress commit 2017-01-12 15:41:20 -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 MyAnimeList.net

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 7.3+
  • 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