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.
418 Commits 2 Branches 10 Tags 29 MiB
PHP 90%
CSS 4.8%
JavaScript 4.1%
HTML 0.9%
Just 0.2%
f1e5a0a237
Go to file
Timothy J Warren f1e5a0a237 Actually install dev dependencies for gitlab ci
2017-02-28 13:52:39 -05:00
app Simplify database config example 2017-02-21 14:56:10 -05:00
build Simplify gitlab ci setup 2017-02-28 13:17:06 -05:00
migrations Ugly progress commit 2016-12-20 12:58:37 -05:00
public Make sure anime detail pages don't distort images 2017-02-21 12:24:34 -05:00
src More PHPStan fixes 2017-02-22 15:08:29 -05:00
tests More PHPStan fixes 2017-02-22 15:08:29 -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 Actually install dev dependencies for gitlab ci 2017-02-28 13:52:39 -05:00
.htaccess Add basic htaccess file for apache 2016-02-05 14:14:02 -05:00
.travis.yml Attempt to fix hhvm tests 2017-02-10 16:33:42 -05:00
CHANGELOG.md Update changelog 2017-02-06 10:57:38 -05:00
composer.json Add phpunit as a dev dependency 2017-02-28 13:39:49 -05:00
console Ugly progress commit 2017-01-27 12:35:28 -05:00
humbug.json.dist Set up mutation testing for unit tests 2016-08-01 14:38:23 -04:00
index.php More PHPStan fixes 2017-02-22 15:08:29 -05:00
LICENSE Add license 2017-01-27 16:34:03 -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 Lots of style fixes, with more to come 2017-02-17 10:55:17 -05:00
phpdox.xml Lots of style fixes, with more to come 2017-02-17 10:55:17 -05:00
phpunit.xml Really ugly progress commit 2017-01-12 15:41:20 -05:00
README.md Move some README info to the wiki 2017-02-21 15:56:19 -05:00
RoboFile.php Will teh Gitlab build be triggered? 2017-02-20 15:13:16 -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 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 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

  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