dreamfactory/df-core

DreamFactory Core

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 is a secure, self-hosted enterprise data access platform that provides governed API access to any data source, connecting enterprise applications and on-prem LLMs with role-based access and identity passthrough.

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. For more information, see the full platform repository.

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

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

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 LaravelServiceProvider in the Providers array.

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

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.

If you have setup your database connection right in your .env file then run the following migration.

php artisan migrate

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/

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 based on our develop 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.