README.md

Cineboard restful API

Manage movie collections for you, family or friends.

Try it now!

Check the Demo running on firegarden.co

(thanks for support with free hosting man!!!)

Feedback are welcome!

Application Components

• RESTful API slim php framework
• Eloquent ORM illuminate database
• WebGUI AngularJS
• RDBMS MariaDB 10.1

TO THE USERS

First: we need to clone both front/api repositories. Then create database, a little help from the api repos (mysql/mariadb already running). Edit db.config and db_create.sh to customize configuration and then launch db_create.sh

$ cd sql && bash db_create.sh

Then copy src/settings.php to settings.local.php and customize.

To quickly use the application launch this command on both repositories:

$ bash server-start-builtin.sh $PORT

and browser to localhost:$PORT to load webgui.

TO THE DEVELOPERS and CONTRIBUTORS!

Important! Before to proceed check if php-xdebug is installed and running on your system to avoid errors

$ php -r "echo (extension_loaded('xdebug') ? 'xdebug up and running!' : 'xdebug is not loaded!');"

Check settings for debug => 'true' and monolog level to Logger::DEBUG .

Check with PHPCS

$ php vendor/bin/phpcs --standard=phpcs.xml app/src

Check with PHPMD

$ php vendor/bin/phpmd app/src text phpmd.xml

Check with PHPMetrics

$ php vendor/bin/phpmetrics --report-html=build/phpmetric-report app/src

Check with PHPstan [optional]

Warning! Due to incompatibilities with EloquenORM some false positive will be shown.

$ php vendor/bin/phpstan analyse {-l $level} app/src

Run php unittests

$ php vendor/bin/phpunit

Run unit/functional tests

Functional Tests with Guzzle configurated on port 8081
[TODO: use localhost with docker composed]

$ bash server-start-builtin.sh 8081 &
$ php vendor/bin/phpunit --configuration phpunit_ci.xml

Or use COMPOSER to do all

$ composer run-script tests

Launch with builtin php server

$ bash server-start-builtin.sh $PORT

Docker Env

ALMOST FINISHED: Check Readme inside Docker/ directory.

Authors

• GB 'gionniboy' Pullarà - Firegarden

Acknowledgments

Cineboard graphics&design by Alessia Sferrazza, used with permission.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details

have fun && bugs hunt && issue || PR !