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
|
|
|
[![Build Status](https://travis-ci.org/timw4mail/HummingBirdAnimeClient.svg?branch=master)](https://travis-ci.org/timw4mail/HummingBirdAnimeClient)
|
2019-12-06 09:25:04 -05:00
|
|
|
[![Build Status](https://jenkins.timshomepage.net/buildStatus/icon?job=timw4mail/HummingBirdAnimeClient/develop)](https://jenkins.timshomepage.net/job/timw4mail/HummingBirdAnimeClient/develop)
|
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
|
|
|
|
|
2020-03-11 15:14:34 -04:00
|
|
|
* PHP 7.3+
|
2016-04-19 13:24:21 -04:00
|
|
|
* PDO SQLite or PDO PostgreSQL (For collection tab)
|
2018-10-09 18:15:03 -04:00
|
|
|
* GD extension for caching images
|
|
|
|
|
|
|
|
### Highly Recommended
|
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`
|
2018-10-09 18:15:03 -04:00
|
|
|
2. Duplicate `app/config/config.toml.example` file as `app/config/config.toml`
|
2016-04-19 13:24:21 -04:00
|
|
|
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
|
2018-10-09 18:15:03 -04:00
|
|
|
* app/config
|
2017-04-28 13:20:34 -04:00
|
|
|
* app/logs
|
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
|
2018-10-09 18:15:03 -04:00
|
|
|
6. Additional settings are on the settings page once you log in.
|
2015-06-16 15:54:10 -04:00
|
|
|
|
2016-02-09 16:45:22 -05:00
|
|
|
### Server Setup
|
|
|
|
|
2018-04-05 21:20:43 -04:00
|
|
|
See the [wiki](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/wiki)
|
2017-02-21 15:56:19 -05:00
|
|
|
for more in-depth information
|
2015-06-16 15:54:10 -04:00
|
|
|
|