1
0
mirror of https://github.com/devfake/flox.git synced 2024-11-15 06:32:34 +01:00
flox/README.md

46 lines
1.6 KiB
Markdown
Raw Normal View History

2015-07-27 20:49:37 +02:00
![flox](http://80.240.132.120/flox/public/assets/img/logo-big.png)
###[Try Demo](http://80.240.132.120/flox/public/)
Flox is a self hosted Movie watch list. It's build on top of PHP (Laravel), MySQL and React and uses [The Movie Database](https://www.themoviedb.org/) API.
2015-07-27 20:49:37 +02:00
**The current status miss some important features. See Todo.**
2015-07-30 11:53:48 +02:00
The rating based on an 5-Point system with 0.5 steps.
2015-07-27 20:49:37 +02:00
### Requirements
* PHP 5.5.9+
* [Composer](https://getcomposer.org/)
* [The Movie Database](https://www.themoviedb.org/) Account for the [API-Key](https://www.themoviedb.org/faq/api).
### Install
2016-05-30 08:58:17 +02:00
##### Backend
2015-07-27 20:49:37 +02:00
2016-05-30 08:58:17 +02:00
* Download Flox and `cd` into `backend`.
2015-07-27 20:49:37 +02:00
* Rename `.env.example` to `.env` and fill all your credentials out (your database and TMDb API-Key).
* Run `composer install`.
* Give `storage` recursive write access.
2015-07-28 11:25:12 +02:00
* Run `php artisan key:generate`.
2015-07-27 20:49:37 +02:00
* Run `php artisan migrate`. This builds the database schema for Flox.
* Since the insertion of new items currently not working, run `php artisan db:seed` for prefabricated items.
##### Client / Public
2015-07-28 12:07:38 +02:00
* Open the `/public/assets/js/config.js` file and modify them. The `uri` is needed for the react-router. If your app lives in the root folder, change it to `/`. The rest should be clear.
2015-07-27 20:49:37 +02:00
**Only for development:**
* Run `npm install` in your `client` folder.
* Run `gulp watch` or `gulp watch --production` and make your work.
2015-07-28 12:07:38 +02:00
### Misc
There is a light theme option: Add `light-theme` class to `body` in `/client/views/app.blade.php`.
2015-07-27 20:49:37 +02:00
### Todo
* Add movies.
* Login for admin (create movie categories).
* Import lists from imdb and letterboxd.