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.
651 Commits 2 Branches 10 Tags 29 MiB
PHP 90%
CSS 4.8%
JavaScript 4.1%
HTML 0.9%
Just 0.2%
5b4e1df740
Go to file
Timothy J Warren 5b4e1df740 Update README
2018-10-09 18:15:03 -04:00
app Full Anilist settings page OAuth flow, ability to run app without manually editing config files. See #7. Resolves #5 2018-10-09 18:10:20 -04:00
build Update header comments to version 4.1 2018-10-01 11:35:51 -04:00
migrations Rough start of Manga collection...need to set up proper structure for manga collection items 2017-09-14 16:18:13 -04:00
public Full Anilist settings page OAuth flow, ability to run app without manually editing config files. See #7. Resolves #5 2018-10-09 18:10:20 -04:00
src Full Anilist settings page OAuth flow, ability to run app without manually editing config files. See #7. Resolves #5 2018-10-09 18:10:20 -04:00
tests Update code to use simpler config 2018-10-05 14:32:05 -04:00
.editorconfig Some progress toward better structure through refactoring 2015-09-14 10:54:50 -04:00
.gitignore Update gitignore 2018-10-08 15:44:03 -04:00
.gitlab-ci.yml Update dependencies 2017-12-06 11:48:15 -05:00
.htaccess Update htaccess so images can load 2017-04-28 13:20:59 -04:00
.travis.yml Remove php 7.0 test 2018-01-16 15:04:25 -05:00
CHANGELOG.md Settings control panel saves to admin-override.toml in the app/config directory, resolves #7 2018-10-08 15:45:46 -04:00
composer.json Add command to check Kitsu's MAL id mappings 2018-10-05 14:40:30 -04:00
console Ugly progress commit 2018-09-27 16:45:12 -04:00
index.php More settings, now with tabs 2018-10-08 16:38:08 -04: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 Fix some documentation generation issues 2018-01-10 16:24:00 -05:00
phpdox.xml Update doc generation 2017-04-06 21:27:47 -04:00
phpstan.neon Lots of style fixes and minor logic tweaks 2018-01-18 16:21:45 -05:00
phpunit.xml Really ugly progress commit 2017-01-12 15:41:20 -05:00
README.md Update README 2018-10-09 18:15:03 -04:00
RoboFile.php Code cleanup and fix 'On Hold' title on all section of anime list 2017-03-27 10:09:45 -04:00
sw.js Settings control panel saves to admin-override.toml in the app/config directory, resolves #7 2018-10-08 15:45:46 -04:00

README.md

Hummingbird Anime Client

Update your anime/manga list on Kitsu.io and MyAnimeList.net

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 7.1+
  • PDO SQLite or PDO PostgreSQL (For collection tab)
  • GD extension for caching images

Highly Recommended

  • Redis or Memcached for caching

Installation

  1. Install via git, then install dependencies via composer: composer install
  2. Duplicate app/config/config.toml.example file as app/config/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
    • app/config
    • app/logs
    • public/images/avatars
    • public/images/anime
    • public/images/characters
    • public/images/manga
  5. Make sure the console script is executable
  6. Additional settings are on the settings page once you log in.

Server Setup

See the wiki for more in-depth information