2015-06-16 11:33:06 -04:00
|
|
|
# Hummingbird Anime Client
|
|
|
|
|
|
|
|
|
|
A self-hosted client that allows custom formatting of data from the hummingbird api
|
|
|
|
|
|
2015-11-18 16:03:40 -05:00
|
|
|
[](https://jenkins.timshomepage.net/job/animeclient/)
|
2016-01-08 11:40:24 -05:00
|
|
|
[](https://travis-ci.org/timw4mail/HummingBirdAnimeClient)
|
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
|
|
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
* PHP 5.5+
|
2015-06-16 11:33:06 -04:00
|
|
|
* PDO SQLite (For collection tab)
|
2015-06-25 17:00:29 -04:00
|
|
|
* GD
|
2015-06-16 11:33:06 -04:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
2016-01-11 14:39:53 -05:00
|
|
|
1. Install via composer: `composer create-project timw4mail/hummingbird-anime-client`
|
2015-10-05 16:54:25 -04:00
|
|
|
2. Configure settings in `app/config/config.php` to your liking
|
2015-09-16 12:25:35 -04:00
|
|
|
3. Create the following directories if they don't exist, and make sure they are world writable
|
2015-06-25 17:05:58 -04:00
|
|
|
* app/cache
|
2016-02-02 11:34:03 -05:00
|
|
|
* public/js/cache
|
2015-06-25 17:05:58 -04:00
|
|
|
* public/images/manga
|
|
|
|
|
* public/images/anime
|
2015-06-16 15:54:10 -04:00
|
|
|
|
2016-02-09 16:45:22 -05:00
|
|
|
### Server Setup
|
|
|
|
|
|
|
|
|
|
#### nginx
|
|
|
|
|
Basic nginx setup
|
|
|
|
|
|
|
|
|
|
```nginx
|
|
|
|
|
server {
|
|
|
|
|
location / {
|
|
|
|
|
try_files $uri $uri/ /index.php$uri?$args;
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-09 21:42:56 -05:00
|
|
|
location ~ ^(.+\.php)($|/) {
|
2016-02-09 16:45:22 -05:00
|
|
|
fastcgi_split_path_info ^(.+\.php)(.*)$;
|
|
|
|
|
fastcgi_index index.php;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
location ^~ /vendor {
|
|
|
|
|
deny all;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### Apache
|
|
|
|
|
Make sure to have `mod_rewrite` and `AllowOverride All` enabled in order to take
|
|
|
|
|
advantage of the included `.htaccess` file. If you don't wish to use an `.htaccess` file,
|
|
|
|
|
include the contents of the `.htaccess` file in your Apache configuration.
|
|
|
|
|
|
2015-06-16 15:54:10 -04:00
|
|
|
#### Anime Collection Additional Installation
|
|
|
|
|
* Run `php /vendor/bin/phinx migrate -e development` to create the database tables
|
|
|
|
|
* For importing anime:
|
2015-11-18 16:03:40 -05:00
|
|
|
1. Login
|
|
|
|
|
2. Use the form to select your media
|
2016-01-11 14:39:53 -05:00
|
|
|
3. Save & Repeat as needed
|
2015-07-06 14:35:24 -04:00
|
|
|
* For bulk importing anime:
|
2015-06-16 15:54:10 -04:00
|
|
|
1. Find the anime you are looking for on the hummingbird search api page: `https://hummingbird.me/api/v1/search/anime?query=`
|
|
|
|
|
2. Create an `import.json` file in the root of the app, with an array of objects from the search page that you want to import
|
|
|
|
|
3. Go to the anime collection tab, and the import will be run
|
|
|
|
|
|
