API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy Warren fb8db698a6 Fix some documentation generation issues 2018-01-10 16:24:00 -05:00
app Update Artax, and update other code to work with new version 2017-12-08 22:32:00 -05:00
build Fix some documentation generation issues 2018-01-10 16:24:00 -05: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 Artax, and update other code to work with new version 2017-12-08 22:32:00 -05:00
src Handle syncing errors more consistently 2018-01-10 16:18:06 -05:00
tests Update Artax, and update other code to work with new version 2017-12-08 22:32:00 -05:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Use proxy and cached images on user info page 2017-04-13 14:25:39 -04:00
.gitlab-ci.yml Update dependencies 2017-12-06 11:48:15 -05:00
.htaccess Update htaccess so images can load 2017-04-28 13:20:59 -04:00
.travis.yml Test with php 7.2 2017-09-12 12:38:26 -04: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 with another folder that needs to be writable 2017-04-28 13:20:34 -04: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 Handle syncing errors more consistently 2018-01-10 16:18:06 -05:00
console Miscellaneous code cleanup 2017-04-17 16:13:36 -04:00
index.php Update Artax, and update other code to work with new version 2017-12-08 22:32:00 -05: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 Fix some documentation generation issues 2018-01-10 16:24:00 -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
    • app/logs
    • public/js/cache
    • public/images/avatars
    • public/images/anime
    • public/images/characters
    • public/images/manga
  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