HummingBirdAnimeClient/README.md

67 lines
1.8 KiB
Markdown
Raw Normal View History

2015-06-16 11:33:06 -04:00
# Hummingbird Anime Client
2020-04-10 16:35:01 -04:00
Update your anime/manga list on Kitsu.io and Anilist
2015-06-16 11:33:06 -04:00
2020-04-10 16:35:01 -04:00
[![Build Status](https://travis-ci.com/timw4mail/HummingBirdAnimeClient.svg?branch=master)](https://travis-ci.com/github/timw4mail/HummingBirdAnimeClient)
2021-02-05 17:19:11 -05:00
[![Build Status](https://jenkins.timshome.page/buildStatus/icon?job=timw4mail/HummingBirdAnimeClient/develop)](https://jenkins.timshome.page/job/timw4mail/job/HummingBirdAnimeClient/job/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
* 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
* 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
* PHP 8.2
* ext-dom (For editing the DOM)
* ext-gd (For caching images)
* ext-intl (For time localization)
* ext-json
* ext-mbstring
* ext-pdo
2018-10-09 18:15:03 -04:00
### Highly Recommended
2017-01-16 12:42:30 -05:00
* Redis or Memcached for caching
* PDO SQLite or PDO PostgreSQL (For collection tab)
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
* 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.
### Server Setup
See the [wiki](https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient/wiki)
2017-02-21 15:56:19 -05:00
for more in-depth information