API client for Kitsu.io, with optional Anime collection, and optional Anilist syncing.
Go to file
Timothy Warren 270f9ab167 Really ugly progress commit 2017-01-12 15:41:20 -05:00
app Really ugly progress commit 2017-01-12 15:41:20 -05:00
build Really ugly progress commit 2017-01-12 15:41:20 -05:00
migrations Ugly progress commit 2016-12-20 12:58:37 -05:00
public Fix unit tests 2017-01-10 21:13:44 -05:00
src Really ugly progress commit 2017-01-12 15:41:20 -05:00
tests Really ugly progress commit 2017-01-12 15:41:20 -05:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Set up mutation testing for unit tests 2016-08-01 14:38:23 -04:00
.gitlab-ci.yml Ugly progress commit 2016-12-20 12:58:37 -05:00
.htaccess Add basic htaccess file for apache 2016-02-05 14:14:02 -05:00
.travis.yml Update CI tools to exclude old PHP versions 2016-11-01 09:10:11 -04:00
CHANGELOG.md Update Changelog and Readme 2017-01-12 11:31:49 -05:00
README.md Update Changelog and Readme 2017-01-12 11:31:49 -05:00
RoboFile.php Update Robofile to work properly 2016-08-30 11:45:17 -04:00
composer.json Really ugly progress commit 2017-01-12 15:41:20 -05:00
console Ugly progress commit 2016-12-20 12:58:37 -05:00
humbug.json.dist Set up mutation testing for unit tests 2016-08-01 14:38:23 -04:00
index.php Better handling of alternate titles, Airing Status and genres for anime list views 2017-01-05 22:24: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 Code style fixes to satisfy phpcs 2016-08-30 10:57:41 -04:00
phpunit.xml Really ugly progress commit 2017-01-12 15:41:20 -05: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
    • 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