API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy Warren 1afb45522d Remove redundant cache loading 2016-04-22 10:52:42 -04:00
app Add button to clear api cache 2016-04-21 11:14:21 -04:00
build Update header comments, add start of manga editing functionality 2016-01-04 16:58:33 -05:00
migrations Update first migration to allow empty notes on collection 2016-04-08 13:39:37 -04:00
public Shrink api clearing button 2016-04-22 10:47:18 -04:00
src/Aviat Remove redundant cache loading 2016-04-22 10:52:42 -04:00
tests Update changelog and add additional tests 2016-04-19 14:51:58 -04:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Add caching to Manga views 2016-04-07 13:11:45 -04:00
.htaccess Add basic htaccess file for apache 2016-02-05 14:14:02 -05:00
.travis.ini Update travis config to test redis 2016-04-08 14:56:09 -04:00
.travis.yml Remove allowed failures for PHP 5.5 & 5.6 2016-04-08 15:21:10 -04:00
CHANGELOG.md Update changelog and add additional tests 2016-04-19 14:51:58 -04:00
README.md Update README for version 3 2016-04-19 13:24:21 -04:00
build.xml Make build.xml file more phing friendly 2016-02-03 21:24:10 -05:00
composer.json Add batch image thumbnail creation, see #6, #14 2016-04-19 13:02:50 -04:00
console Update changelog and add additional tests 2016-04-19 14:51:58 -04:00
index.php Start of migration from php to toml config, see #11 2016-02-10 17:30:45 -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 Update sonarqube version 2016-04-14 18:03:34 -04: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 or PDO PostgreSQL (For collection tab)
  • GD
  • Redis and PHP Redis extension (optional, for caching)

Installation

  1. Install via composer: composer create-project timw4mail/hummingbird-anime-client

or

  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
    • public/images/manga
    • public/images/anime
  5. Make sure the console script is executable

  6. To batch-create image thumbnails, run console cache-images.

Server Setup

Caching

To setup API caching, choose a caching method:

  • Database

    1. Follow the instructions for the Anime Collection setup below.
    2. Set cache_driver in app/config/config.toml to 'SQLDriver'
  • Redis

    1. Copy app/redis.toml.example to app/redis.toml, and edit to match your setup.
    2. Set cache_driver in app/config/config.toml to 'RedisDriver'

nginx

Basic nginx setup

server {
	location / {
		try_files $uri $uri/ /index.php$uri?$args;
	}

	location ~ ^(.+\.php)($|/) {
		fastcgi_split_path_info ^(.+\.php)(.*)$;
		fastcgi_index index.php;
	}

	location ^~ /vendor {
		deny all;
	}
}

Apache

Make sure to have mod_rewrite and AllowOverride All enabled in order to take advantage of the included .htaccess file. If you don't wish to use an .htaccess file, include the contents of the .htaccess file in your Apache configuration.

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