64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
# Hummingbird Anime Client
|
|
|
|
Update your anime/manga list on Kitsu.io and MyAnimeList.net
|
|
|
|
[](https://travis-ci.org/timw4mail/HummingBirdAnimeClient)
|
|
[](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/commits/develop)
|
|
[](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/commits/develop)
|
|
[](https://scrutinizer-ci.com/g/timw4mail/HummingBirdAnimeClient/?branch=master)
|
|
|
|
[[Hosted Example](https://list.timshomepage.net)]
|
|
|
|
## 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
|
|
* Redis or Memcached for caching
|
|
|
|
### Installation
|
|
|
|
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
|
|
* app/logs
|
|
* public/js/cache
|
|
* public/images/avatars
|
|
* public/images/anime
|
|
* public/images/characters
|
|
* public/images/manga
|
|
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](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/wikis/home)
|
|
for more in-depth information
|
|
|