2016-10-10 10:57:39 +02:00
Flox
===============
2016-11-28 12:46:49 +01:00
Flox is a self hosted Movie, Series and Animes watch list. It's build on top of Laravel and Vue.js and uses [The Movie Database ](https://www.themoviedb.org/ ) API.
2016-10-10 10:57:39 +02:00
The rating based on an 3-Point system for `good` , `medium` and `bad` .
2016-10-11 08:23:01 +02:00
###[Try live demo](http://80.240.132.120/flox-demo/public/) and [login](http://80.240.132.120/flox-demo/public/login) with `demo / demo` to add new movies or change ratings.
2016-10-10 17:46:03 +02:00
2016-12-06 10:07:57 +01:00
2016-10-10 17:46:03 +02:00
2016-10-10 10:57:39 +02:00
### Requirements
* PHP >=5.6.4
2016-10-13 15:54:43 +02:00
* Database (MySQL or [other ](https://laravel.com/docs/5.3/database ))
2016-10-10 10:57:39 +02:00
* [Composer ](https://getcomposer.org/ )
2016-10-11 15:26:49 +02:00
* The Movie Database Account for the free [API-Key ](https://www.themoviedb.org/faq/api )
2016-10-10 10:57:39 +02:00
### Install
```bash
2016-11-30 11:39:47 +01:00
git clone https://github.com/devfake/flox
cd flox/backend
2016-10-10 10:57:39 +02:00
composer install
php artisan flox:init # Enter here your database credentials
php artisan flox:db # Running migrations and enter your admin credentials for the site
```
2016-11-30 11:39:47 +01:00
* Give `backend/storage` , `public/assets` and `public/exports` recursive write access.
2016-10-14 12:15:54 +02:00
* Enter your TMDb API-Key in `backend/.env`
2016-10-10 10:57:39 +02:00
* Set your `CLIENT_URI` in `backend/.env` . If you use something like XAMPP or MAMP, the CLIENT_URI should be `/flox/public` . If you use something like Homestead, the CLIENT_URI should be `/` .
2016-10-13 16:15:11 +02:00
```bash
# CLIENT_URI=/flox/public
http://localhost:8888/flox/public
# CLIENT_URI=/subfolder/for/flox/public
http://mydomain.com/subfolder/for/flox/public
# CLIENT_URI=/
http://mydomain.com
```
2016-10-10 10:57:39 +02:00
2016-10-14 12:15:54 +02:00
### Suggestions
2016-10-11 11:06:58 +02:00
2016-11-28 12:46:49 +01:00
If you hover over an item, you can click on `Suggestions` to search for recommendations and similar movies or shows.
2016-10-14 12:15:54 +02:00
### Popular Movies
`Trending` will display a list of the current popular movies on TMDb. This list updates daily.
2016-10-11 11:06:58 +02:00
2016-10-14 13:25:52 +02:00
### Upcoming Movies
`Upcoming` will display new movies which will be released soon. TMDb do not yet support regional queries but this is coming soon.
2016-11-30 11:39:47 +01:00
### Update
For each update i will make an extra [release ](https://github.com/devfake/flox/releases ).
These are the common steps to upgrade flox:
```bash
git fetch
git checkout x.x.x
cd backend
composer install
php artisan migrate
```
If you go to the settings page of your installation, flox will automatically check for new updates.
2016-10-11 11:06:58 +02:00
### Export / Import
2016-11-28 12:46:49 +01:00
Also you can make a backup of all your movies and shows in the settings page. If you click the `EXPORT MOVIES` button, there will be an download for an `json` file. This file contains all your movies and shows from your database. This backup file will also be automatically saved in your `public/exports` folder.
2016-10-11 11:06:58 +02:00
2016-11-28 12:46:49 +01:00
If you import an backup, all movies and shows in your database will be deleted and replaced. Be sure to make an current backup before you import.
2016-10-11 11:06:58 +02:00
The import will download all poster images.
2016-11-23 16:24:34 +01:00
### Translation
2016-10-10 10:57:39 +02:00
2016-11-28 12:46:49 +01:00
All titles are in english by default. You can change your language by setting `TRANSLATION` in `backend/.env` . The most commons are `DE` , `IT` , `FR` , `ES` and `RU` . You can try to use your language code.
2016-11-23 21:16:41 +01:00
This will also affect the language of you website. See in `client/resources/languages` if your language is supported. Pull requests are welcome :)
If there isn't a translation for your language, english will be used.
2016-10-10 10:57:39 +02:00
### Better Search
You can use [Laravel Scout ](https://laravel.com/docs/master/scout ) for better search results with typos. Something like `findg nemo` .
Add your driver and API-Keys in `backend/.env` and uncomment `use Searchable;` in `backend/app/Item.php` on line 11.
2016-11-28 12:46:49 +01:00
To sync your own list with your Laravel Scout driver, run `php artisan flox:sync` (If you using Laravel Scout later).
2016-10-10 10:57:39 +02:00
[Algolia ](https://www.algolia.com/ ) is a great service and has a free hacker plan.
2016-11-23 16:45:19 +01:00
**Note**: This works only for **your** database.
2016-10-10 10:57:39 +02:00
2016-10-18 09:57:47 +02:00
### Settings
2016-10-14 12:15:54 +02:00
You can edit your admin account (username and password) in the settings page (link is in footer).
2016-11-28 12:46:49 +01:00
You can also set options to display release date and/or genre of your own list. Both will still display on search, trending and upcoming.
2016-10-18 09:57:47 +02:00
2016-12-12 09:26:40 +01:00
There is an option to enable or disable spoiler protection for episode names.
2016-10-10 10:57:39 +02:00
### Development
2016-11-23 11:41:26 +01:00
* Run `npm install` or `yarn` in your `/client` folder.
2016-10-10 10:57:39 +02:00
* Make sure you have installed `webpack` globally.
* Run `npm run dev` or `npm run build` .
2016-12-15 08:41:10 +01:00
### Contribution
Like this project? Want to contribute? Awesome! Feel free to open some pull requests or just open an issue. See [Projects ](https://github.com/devfake/flox/projects/1 ) for the current roadmap.
### Changelog
Detailed changes for each release are documented in the [release notes ](https://github.com/devfake/flox/releases ).
### License
Flox is published under the MIT license. See LICENSE for more information.
