README

Note: This framework is not stable yet.

This application is a useful starting point for projects that use the Aphiria framework. Check out this repository, and get started building your own REST API.

Installation

Aphiria can be installed using Composer:

composer create-project aphiria/app --prefer-dist --stability dev

Running Locally

You can run your app locally either directly via the built-in PHP web server or via Docker Compose. Both solutions result in your app being hosted at http://localhost:8080.

Built-In PHP Web Server

php aphiria app:serve

Docker Compose Web Server

This app comes bundled with a Docker Compose setup meant to ease local development. It is not meant for production, but can get you up and running quickly with an nginx web server running your application along with Xdebug for debugging. Simply run:

docker compose up -d --build app

To start debugging with Xdebug, configure your IDE to map your checked out Aphiria code to the /app directory within the php service created by Docker Compose. Ensure that your IDE is configured to listen to port 9004 for Xdebug connections.

Demo

This app comes with a simple demo that can store, retrieve, and authenticate users from a local SQLite database. It uses Phinx to manage database migrations and seeding, which can be executed with the following commands, respectively:

vendor/bin/phinx migrate
vendor/bin/phinx seed:run

Phinx-specific configuration settings, eg the paths to migration and seed files, are located in phinx.php.

Learn More

To learn more about how to use Aphiria, read its documentation.

aphiria / app

Maintainers

Details