Alex/flox
1
0
Fork 0
mirror of https://github.com/devfake/flox.git synced 2024-11-14 22:22:39 +01:00
Code Issues Releases Wiki Activity
62c94dd740
flox/README.md
devfake 62c94dd740 sync scout in settings
2016-10-19 11:19:34 +02:00

3.7 KiB
Raw Blame History

Flox

Flox is a self hosted Movie watch list. It's build on top of Laravel and Vue.js and uses The Movie Database API. The rating based on an 3-Point system for good, medium and bad.

###Try live demo and login with demo / demo to add new movies or change ratings.

flox

Requirements

Install

  • Download Flox and cd into backend and run
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 /.
# 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

Suggestions

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

Popular Movies

Trending will display a list of the current popular movies on TMDb. This list updates daily.

Upcoming Movies

Upcoming will display new movies which will be released soon. TMDb do not yet support regional queries but this is coming soon.

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.

Better Search

You can use Laravel 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 is a great service and has a free hacker plan.

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

Settings

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

You can also set options to display release date and/or genre of your own movie list. Both will still display on search, trending and upcoming.

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.

Further Development

  • Multi User
  • Change alternative_title with translation
  • Series and Animes?
  • Laravel installer?