PHP Shell HTML Other
wjgilmore Version bump
Version bump
Latest commit f085e75 Aug 1, 2018
Permalink
Failed to load latest commit information.
.bp-config Adding CloudFoundry manifest/setup files to Dreamfactory. Oct 19, 2017
app DF-1249 Code cleanup. Removed first user check middleware from DF bas… Dec 14, 2017
bootstrap Restructuring to upgrade to Laravel 5.4 Feb 6, 2017
config version bump Feb 25, 2018
database Fix grammer on app description. Aug 10, 2017
public upgrade to Laravel 5.5 Nov 8, 2017
resources upgrade to Laravel 5.5 Nov 8, 2017
routes Restructuring to upgrade to Laravel 5.4 Feb 6, 2017
server/config updated vagrant configuration script Jan 25, 2018
storage fix gitignore Jun 2, 2017
tests upgrade to Laravel 5.5 Nov 8, 2017
.cfignore Adding CloudFoundry manifest/setup files to Dreamfactory. Oct 19, 2017
.dreamfactory.php DF-1150 Update copyright and support email Nov 7, 2017
.env-dist DF-1287 Fixed NodeJS (and Python) script execution for large script. … Jan 16, 2018
.gitattributes Restructuring to upgrade to Laravel 5.4 Feb 6, 2017
.gitignore updated homestead configs Oct 20, 2017
CHANGELOG.md version bump Feb 25, 2018
LICENSE Initial commit Apr 30, 2015
README.md Version bump Aug 1, 2018
Vagrantfile updated homestead config to support --dev option Nov 8, 2017
artisan upgrade to Laravel 5.5 Nov 8, 2017
composer.json Version bump Aug 1, 2018
composer.json-dist Version bump Aug 1, 2018
composer.lock Version bump Aug 1, 2018
installer.sh cleanup Jul 28, 2017
manifest.yml Adding CloudFoundry manifest/setup files to Dreamfactory. Oct 19, 2017
package.json upgrade to Laravel 5.5 Nov 8, 2017
phpspec.yml rename application to DreamFactory namespace Jun 16, 2015
phpunit.xml-dist composer update Dec 29, 2017
server.php Restructuring to upgrade to Laravel 5.4 Feb 6, 2017
webpack.mix.js upgrade to Laravel 5.5 Nov 8, 2017
yarn.lock upgrade to Laravel 5.5 Nov 8, 2017

README.md

DreamFactory 2.13.0

License

Overview

DreamFactory(™) is an open source REST API backend for mobile, web, and IoT applications. It is built on top of the Laravel framework, and as such retains the requirements of the [Laravel v5.4 framework]

  • Get powerful, reusable, documented APIs for SQL, NoSQL, files, email, push notifications and more in seconds.
  • Use server-side scripts to easily customize API behavior at any endpoint, for both API requests and API responses.
  • Secure every API endpoint with user management, SSO authentication, role-based access control, OAuth and Active Directory integration.

Learn more at our website.

Documentation

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

Required Software and Extensions

Check our wiki installation page for the minimum software and extensions required for your system to successfully install and run DreamFactory 2.x.

Quick Setup

These instructions allow you to quickly install DreamFactory 2.x on your system and try it out. The commands shown here are primarily for a Linux based OS, but this should also work on Windows with all the required software and extensions installed.

Note: This quick setup instruction assumes that you are familiar with composer, git and the basics of how to setup a web and database server.

  • Clone this repository to a directory on your system.

    git clone https://github.com/dreamfactorysoftware/dreamfactory.git ~/df2
  • Change directory.

    cd ~/df2
  • Install dependencies using composer. If composer is not installed, see here.

    composer install --no-dev
  • DreamFactory sets up a default SQLite database by default. If you would like your instance to store system information in another database, run the following command. This will create your system environment file (.env) and will prompt you to configure your database of choice.

    php artisan df:env
  • Regardless of what database you choose, run the following command to setup your database. This will create your system environment, generate your application key, run the database schema migration, seed the default services, and will prompt you to create your admin user account.

    php artisan df:setup
  • Make sure your web server can read/write from/to storage/ (sub directories) and bootstrap/cache/ directories.

    # Example:
    
    sudo chown -R {www user}:{your user group} storage/ bootstrap/cache/
    sudo chmod -R 2775 storage/ bootstrap/cache/
  • Run the following command to try out DreamFactory 2.0 without configuring a web server. Otherwise, configure your web server to serve the public/ directory and launch your instance from a browser.

    php artisan serve

Customize the Installation

To customize any of the environment settings or feature sets included in the install, run the new installer program.

Note this requires Bash 4.0 or newer.

  • Run the installer and follow the prompts. If the installer can not be run, you may edit the .env file directly.

    ./installer.sh
  • Run following commands to clear system cache.

    php artisan cache:clear
    php artisan config:clear
  • If the system database environment is changed to a clean database, re-run the setup command.

    php artisan df:setup

Feedback and Contributions

  • Feedback is welcome on our forum or 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 to be considered.