API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy Warren 3f81068182 Update doc generation 2017-04-06 21:27:47 -04:00
app Make sure Cast heading only shows up if there are actual cast entries 2017-04-06 21:27:03 -04:00
build Update header comments 2017-03-30 16:49:48 -04:00
migrations Ugly progress commit 2016-12-20 12:58:37 -05:00
public Simplify css and javascript minification 2017-04-06 11:45:25 -04:00
src Make sure Cast heading only shows up if there are actual cast entries 2017-04-06 21:27:03 -04:00
tests Make sure rating parameter sent to Kitsu is greater than 0 2017-04-06 14:53:38 -04:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Update gitignore, and make sure cache directory for js minifier exists 2017-03-07 17:48:35 -05:00
.gitlab-ci.yml Fix php 7.1 build? 2017-03-22 11:43:20 -04:00
.htaccess Add basic htaccess file for apache 2016-02-05 14:14:02 -05:00
.travis.yml Attempt to fix travis ci after switch to phpdbg 2017-02-28 14:24:32 -05:00
CHANGELOG.md Add rereading info to manga list 2017-03-30 14:50:25 -04:00
LICENSE Add license 2017-01-27 16:34:03 -05:00
README.md Update README 2017-03-03 11:33:42 -05:00
RoboFile.php Code cleanup and fix 'On Hold' title on all section of anime list 2017-03-27 10:09:45 -04:00
composer.json Use snapshots library with tests to simplify testcases 2017-04-06 11:59:53 -04:00
console Code cleanup and fix 'On Hold' title on all section of anime list 2017-03-27 10:09:45 -04:00
humbug.json.dist Set up mutation testing for unit tests 2016-08-01 14:38:23 -04:00
index.php Remove duplicated function 2017-03-30 16:57:58 -04:00
phinx.yml Update information on anime collection, and remove sqlite file, which can be created by a database migration 2015-06-16 15:54:10 -04:00
phpdoc.dist.xml Lots of style fixes, with more to come 2017-02-17 10:55:17 -05:00
phpdox.xml Update doc generation 2017-04-06 21:27:47 -04:00
phpunit.xml Really ugly progress commit 2017-01-12 15:41:20 -05:00

README.md

Hummingbird Anime Client

Update your anime/manga list on Kitsu.io and MyAnimeList.net

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 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