psx/sample

PSX sample project

Maintainers

Package info

github.com/apioo/psx-sample

Homepage

pkg:composer/psx/sample

Fund package maintenance!

chriskapp

Patreon

www.paypal.me/fusioapi

Statistics

Installs: 1 104

Dependents: 0

Suggesters: 0

Stars: 2

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

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

Requires

Requires (Dev)

MIT a97895fb1ae7155d6819cde24475046e053ea925

This package is auto-updated.

Last update: 2026-05-29 00:53:44 UTC

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.