2015-06-16 11:33:06 -04:00
|
|
|
# Hummingbird Anime Client
|
|
|
|
|
|
2017-03-03 11:33:42 -05:00
|
|
|
Update your anime/manga list on Kitsu.io and MyAnimeList.net
|
2015-06-16 11:33:06 -04:00
|
|
|
|
2016-01-08 11:40:24 -05:00
|
|
|
[](https://travis-ci.org/timw4mail/HummingBirdAnimeClient)
|
2017-01-27 15:41:52 -05:00
|
|
|
[](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/commits/develop)
|
2017-01-27 15:56:40 -05:00
|
|
|
[](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/commits/develop)
|
2015-07-06 14:35:24 -04:00
|
|
|
[](https://scrutinizer-ci.com/g/timw4mail/HummingBirdAnimeClient/?branch=master)
|
2015-06-25 17:05:58 -04:00
|
|
|
|
2015-11-18 16:03:40 -05:00
|
|
|
[[Hosted Example](https://list.timshomepage.net)]
|
2015-06-16 11:33:06 -04:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
2015-06-16 15:54:10 -04:00
|
|
|
* Anime List views (Each with list and cover views):
|
2015-06-16 11:33:06 -04:00
|
|
|
* Watching
|
|
|
|
|
* Plan to Watch
|
|
|
|
|
* On Hold
|
|
|
|
|
* Dropped
|
2015-11-18 16:03:40 -05:00
|
|
|
* Completed
|
2016-01-08 11:40:24 -05:00
|
|
|
* Combined View
|
2015-11-18 16:03:40 -05:00
|
|
|
|
2015-06-16 15:54:10 -04:00
|
|
|
* Manga List views (Each with list and cover views):
|
2015-06-16 11:33:06 -04:00
|
|
|
* Reading
|
|
|
|
|
* Plan to Read
|
|
|
|
|
* On Hold
|
|
|
|
|
* Dropped
|
|
|
|
|
* Completed
|
2016-01-08 11:40:24 -05:00
|
|
|
* Combined View
|
2015-11-18 16:03:40 -05:00
|
|
|
|
2015-06-16 11:33:06 -04:00
|
|
|
* Anime collection view (segmented by media type):
|
|
|
|
|
* Cover Images
|
|
|
|
|
* Table List
|
2015-11-18 16:03:40 -05:00
|
|
|
|
2015-06-16 11:33:06 -04:00
|
|
|
### Requirements
|
|
|
|
|
|
2017-01-16 12:42:30 -05:00
|
|
|
* PHP 7.0+
|
2016-04-19 13:24:21 -04:00
|
|
|
* PDO SQLite or PDO PostgreSQL (For collection tab)
|
2015-06-25 17:00:29 -04:00
|
|
|
* GD
|
2017-01-16 12:42:30 -05:00
|
|
|
* Redis or Memcached for caching
|
2015-06-16 11:33:06 -04:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
2016-04-19 13:24:21 -04:00
|
|
|
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
|
2016-02-02 11:34:03 -05:00
|
|
|
* public/js/cache
|
2017-04-17 16:13:36 -04:00
|
|
|
* public/images/avatars
|
|
|
|
|
* public/images/anime
|
|
|
|
|
* public/images/characters
|
|
|
|
|
* public/images/manga
|
2016-04-19 13:24:21 -04:00
|
|
|
5. Make sure the `console` script is executable
|
2015-06-16 15:54:10 -04:00
|
|
|
|
2017-02-06 10:56:27 -05:00
|
|
|
### Using MAL API
|
|
|
|
|
1. Update `app/config/mal.toml` with your username and password
|
|
|
|
|
2. Enable MAL api in `app/config/config.toml`
|
|
|
|
|
|
2016-02-09 16:45:22 -05:00
|
|
|
### Server Setup
|
|
|
|
|
|
2017-02-21 15:56:19 -05:00
|
|
|
See the [wiki](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/wikis/home)
|
|
|
|
|
for more in-depth information
|
2015-06-16 15:54:10 -04:00
|
|
|
|
