cuulee / df-core Goto Github PK

DreamFactory Core v0.6

Note: This repository contains the core code of the DreamFactory platform. If you want the full DreamFactory platform, visit the main DreamFactory repository.

Overview

DreamFactory(™) Core is a package built on top of the Laravel framework, and as such retains the requirements of the Laravel v5.2 framework.

Documentation

Documentation for the platform can be found on the DreamFactory wiki.

Installation

Note: This document is currently intended for developers who desire to add DreamFactory to an existing Laravel project. It covers how to setup a local environment to start developing DreamFactory(™) packages. For more information, see the full platform repository.

Edit your project’s composer.json to require the following package.

“require”:{
	"dreamfactory/df-core": "~0.6.0"
}

You may also need to add the following…

"minimum-stability": "dev",
"prefer-stable": true,

Save your composer.json and do a "composer update" to install the package. Once the package is installed edit your config/app.php file to add the DfServiceProvider in the Providers array.

‘providers’ => [
	….,
	….,
	'DreamFactory\Core\DfServiceProvider'
]

Next run "php artisan vendor:publish" to publish the config file df.php to config/ directory and a helpful test_rest.html file to public/ directory.

dreamfactory/df-core package also includes some helpful *-dist files inside the config directory. You can take a look at that and copy over what’s needed to the corresponding files of your app. If you have setup your database connection right in your .env file then run the following migration.

php artisan migrate --path=vendor/dreamfactory/df-core/database/migrations/

After the migration run the following seeder class.

php artisan db:seed --class=DreamFactory\\Core\\Database\\Seeds\\DatabaseSeeder

Now if you have setup the phpunit config right in phpunit.xml (Use the supplied phpunit.xml-dist file in the package to use the right params) file then you should be able to run the unit tests.

phpunit vendor/dreamfactory/df-core/tests/

[Note: Remember to turn off laravel 5’s CSRF token validation or you need to supply the valid token for every api call. This can be turned off by commenting out the VerifyCsrfToken middleware inside app/Http/Kernel.php]

Feedback and Contributions

• Feedback is welcome in the form of pull requests and/or issues.
• Contributions should generally follow the strategy outlined in "Contributing to a project"
• All pull requests must be in a "git flow" feature branch and formatted as PSR-2 compliant to be considered.

License

The DreamFactory core is open-sourced software available for use under the Apache Version 2.0 license.