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.
141 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 97dfa89b6d Actually fix view tests 2016-01-08 11:40:24 -05:00
app Fix http verb for update route, add correct http codes for http errors 2016-01-07 20:48:18 -05:00
build Update header comments, add start of manga editing functionality 2016-01-04 16:58:33 -05:00
migrations Scrutinizer Auto-Fixes 2015-06-29 14:26:50 +00:00
public Simplify routing 2016-01-06 11:08:56 -05:00
src/Aviat Fix http verb for update route, add correct http codes for http errors 2016-01-07 20:48:18 -05:00
tests Actually fix view tests 2016-01-08 11:40:24 -05:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Improve some test coverage 2015-11-17 16:45:41 -05:00
.travis.yml update travis build file 2015-12-08 14:58:43 -05:00
README.md Actually fix view tests 2016-01-08 11:40:24 -05:00
build.xml Fix some more code style issues 2015-11-05 11:26:03 -05:00
composer.json Update composer.json 2015-12-16 10:12:31 -05:00
index.php Remove unnamespaced constants, and improve some tests 2016-01-06 15:44:40 -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 Miscellaneous updates, prep for menu generator 2015-10-05 16:54:25 -04:00
sonar-project.properties Fix http verb for update route, add correct http codes for http errors 2016-01-07 20:48:18 -05:00

README.md

Hummingbird Anime Client

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

Build Status 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
    • 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 5.5+
  • PDO SQLite (For collection tab)
  • GD

Installation

  1. Install dependencies via composer: composer install
  2. Configure settings in app/config/config.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