Timothy J. Warren
03505518d6
Some checks failed
timw4mail/HummingBirdAnimeClient/pipeline/head There was a failure building this commit
61 lines
1.7 KiB
Markdown
61 lines
1.7 KiB
Markdown
# Hummingbird Anime Client
|
|
|
|
Update your anime/manga list on Kitsu.io and Anilist
|
|
|
|
[](https://travis-ci.com/github/timw4mail/HummingBirdAnimeClient)
|
|
[](https://jenkins.timshome.page/job/timw4mail/job/HummingBirdAnimeClient/job/develop/)
|
|
|
|
[[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 8
|
|
* 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](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/wiki)
|
|
for more in-depth information
|
|
|