flox/README.md

Flox
===============
Flox is a self hosted Movie watch list. It's build on top of Laravel and Vue.js and uses [The Movie Database](https://www.themoviedb.org/) API.
The rating based on an 3-Point system for `good`, `medium` and `bad`.

###[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.

![flox](http://80.240.132.120/flox-demo/public/assets/img/demo-dark.png)

### Requirements

* PHP >=5.6.4
* Database (MySQL or [other](https://laravel.com/docs/5.3/database))
* [Composer](https://getcomposer.org/)
* The Movie Database Account for the free [API-Key](https://www.themoviedb.org/faq/api)

### Install

* Download Flox and `cd` into `backend` and run
```bash
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
```
* Enter your TMDB API-Key in `backend/.env`
* 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 `/`.
```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
```

### User Data

You can edit your admin account (username and password) in the settings page (link is in footer).

### Export / Import

Also you can make a backup of all your movies 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 from your database. This backup file will also be automatically saved in your `public/exports` folder.

If you import an backup, all movies in your database will be deleted and replaced. Be sure to make an current backup before you import.
The import will download all poster images.

Export and import can also be used for the update of flox itself. Export your movies, download a new version of flox, run all commands and import your backup. Done.

### Alternative Language

All movie titles are in english by default. You can check if TMDB has an alternative title by setting `ALTERNATIVE_LANGUAGE` in `backend/.env`.
The most commons are `DE`, `IT`, `FR`, `ES` and `RU`.

### Suggestions

If you hover over an movie, you can click on `Suggestions` to search for recommendations and similar movies.

### 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.

To sync your own movie list with your Laravel Scout driver, run `php artisan flox:sync` (If you using Laravel Scout later).

[Algolia](https://www.algolia.com/) is a great service and has a free hacker plan.

Note: Laravel Scout is on the demo site not active.

### Development

* Run `npm install` in your `/client` folder.
* Make sure you have installed `webpack` globally.
* Run `npm run dev` or  `npm run build`.

### Misc

* Give `backend/storage`, `public/assets` and `public/exports` recursive write access.

### Todo

* Settings
  * Sync scout driver
* Ajax request for settings

### Further Development

* Explore upcoming and popular movies
* Multi User
* Toggle to display genre or release date?
* Series and Animes?
* Laravel installer?