No description, website, or topics provided.
Pull request Compare This branch is 344 commits behind zfcampus:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

Apigility Skeleton Application


Via release tarball

Grab the latest release via the Apigility website and/or the releases page. At the time of this writing, that URI is:

Untar it:

    tar xzf zf-apigility-skeleton.tgz

Via Composer (create-project)

You can use the create-project command from Composer to create the project in one go:

    curl -s | php --
    php composer.phar create-project -sdev --repository-url="" zfcampus/zf-apigility-skeleton path/to/install

Via Git (clone)

First, clone the repository:

    git clone # optionally, specify the directory in which to clone
    cd path/to/install

At this point, you need to use Composer to install dependencies. Assuming you already have Composer:

    composer.phar install

All methods

Once you have the basic installation, you need to put it in development mode, and add the example API's database:

    cd path/to/install
    php public/index.php development enable # put the skeleton in development mode
    mkdir -p data/db/
    cp vendor/zfcampus/zf-apigility-example/data/status.db data/db/ # copy the example API database

Now, fire it up! Do one of the following:

  • Create a vhost in your web server that points the DocumentRoot to the public/ directory of the project
  • Fire up the built-in web server in PHP (5.4+) (note: do not use this for production!)

In the latter case, do the following:

    cd path/to/install
    php -S 0:8080 -t public/ public/index.php

You can then visit the site at http://localhost:8080/ - which will bring up a welcome page and the ability to visit the dashboard in order to create and inspect your APIs.