psx/sample

PSX sample project

v6.0.0 2021-12-28 15:35 UTC

Requires

• php: >=8.0
• psx/framework: ^6.0

Requires (Dev)

• phpunit/phpunit: ^8.0
• vimeo/psalm: ^4.0

MIT

• Christoph Kappestein

README

About

This is a sample application which 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 https://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/Api/Population/Collection.php
  This is the class which represents the /population endpoint

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

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

• tests/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.