Alex/flox
1
0
Fork 0
mirror of https://github.com/devfake/flox.git synced 2024-11-15 06:32:34 +01:00
Code Issues Releases Wiki Activity
2e230931eb
flox/README.md
devfake 2e230931eb update readme
2016-10-10 12:31:53 +02:00

2.2 KiB
Raw Blame History

flox

Flox

Flox is a self hosted Movie watch list. It's build on top of PHP (Laravel), MySQL 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.

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

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.

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 and public/assets recursive write access.

Todo

  • Settings
    • Export and import
    • Sync scout driver
  • Ajax request for settings
  • Better responsive