psx/sample

v3.0.7 2017-05-08 18:53 UTC

README

About

This is a sample application wich can bootstrap a project based on the PSX framework. You can install it through composer

composer create-project psx/sample .

More information about PSX at http://phpsx.org

Configuration

In the configuration.php file change the key psx_url to the absolute url to the public/ folder. If you have setup a vhost this is simply the domain.

Getting started

In the following a few explanations about the important parts of the API.

  • src/Sample/Api/Population/Collection.php
    This is the class which represents the /population endpoint

  • src/Sample/Service/Population.php
    Service class which contains the business logic of the API.

  • src/Sample/Dependency/Container.php
    DI container which provides the population service

  • tests/Sample/Api/Population/CollectionTest.php Contains the PHPUnit test case for the /population endpoint. If you have phpunit installed you can run the tests in the root of the project with the phpunit command.