timw4mail
/
HummingBirdAnimeClient
1
1
Fork 1
Code Issues 5 Pull Requests Projects 1 Releases Wiki Activity
API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
38 Commits 2 Branches 10 Tags 38 MiB
PHP 90%
CSS 4.8%
JavaScript 4.1%
HTML 0.9%
Just 0.2%
Go to file
Timothy Warren c788cf5d87 Start of refactoring routing to be more convention based 2015-09-16 12:25:35 -04:00
app Start of refactoring routing to be more convention based 2015-09-16 12:25:35 -04:00
migrations Scrutinizer Auto-Fixes 2015-06-29 14:26:50 +00:00
public Miscellaneous rework, and adding/editing of collection items when logged in 2015-07-02 14:04:04 -04:00
src Start of refactoring routing to be more convention based 2015-09-16 12:25:35 -04:00
tests Start of refactoring routing to be more convention based 2015-09-16 12:25:35 -04:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore First unit tests, add a few of the forgotten app requirements 2015-06-25 17:00:29 -04:00
.travis.yml Add scrutinizer checks, and attempt to create cache folders if they do not exist 2015-06-26 15:32:49 -04:00
README.md Start of refactoring routing to be more convention based 2015-09-16 12:25:35 -04:00
composer.json Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
index.php Start of refactoring routing to be more convention based 2015-09-16 12:25:35 -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
phpci.yml Update default config, add phpci config file 2015-07-20 16:13:00 -04:00
phpdoc.dist.xml More namespace refactoring 2015-09-15 13:19:29 -04:00
phpunit.xml More namespace refactoring 2015-09-15 13:19:29 -04:00

README.md

Hummingbird Anime Client

A self-hosted client that allows custom formatting of data from the hummingbird api

Build Status Scrutinizer Code Quality

[Hosted Example]

Features

  • Anime List views (Each with list and cover views):

    • Watching
    • Plan to Watch
    • On Hold
    • Dropped
    • Completed
    • All of the above

  • Manga List views (Each with list and cover views):

    • Reading
    • Plan to Read
    • On Hold
    • Dropped
    • Completed
    • All of the above

  • Anime collection view (segmented by media type):

    • Cover Images
    • Table List

Requirements

  • PHP 5.4+
  • PDO SQLite (For collection tab)
  • GD

Installation

  1. Install dependencies via composer: composer install
  2. Configure settings in app/config/config.php and app/config/routing.php to your liking
  3. Create the following directories if they don't exist, and make sure they are world writable
    • app/cache
    • public/images/manga
    • public/images/anime
    • public/js/cache

Anime Collection Additional Installation

  • Run php /vendor/bin/phinx migrate -e development to create the database tables
  • For importing anime:
    1. Login
    2. Use the form to select your media
    3. Save & Repeat as needed
  • For bulk importing anime:
    1. Find the anime you are looking for on the hummingbird search api page: https://hummingbird.me/api/v1/search/anime?query=
    2. Create an import.json file in the root of the app, with an array of objects from the search page that you want to import
    3. Go to the anime collection tab, and the import will be run