zaphyr-org/app

A skeleton application based on the ZAPHYR framework.

1.0.0-alpha.3 2024-12-22 11:26 UTC

Requires

• php: >=8.1
• zaphyr-org/framework: ^1.0@alpha

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.5
• roave/security-advisories: dev-latest
• squizlabs/php_codesniffer: ^4.0

MIT

• merloxx

• framework
• application
• zaphyr

README

Warning

The app does not yet have a stable version. It is still under development.

Skeleton Application

Use this skeleton application to start your next project with ZAPHYR. This application is pre-configured with the ZAPHYR framework and includes a basic directory structure, configuration files, and a sample controller and view.

This skeleton application is optimized for Composer, making it quick and easy to set up a new application.

System Requirements

Before you start, ensure the following are installed on your system:

• PHP 8.1 or higher, along with the following PHP extensions:
  • Ctype
  • DOM
  • Fileinfo
  • JSON
  • libxml
  • Multibyte String
  • OpenSSL
  • SimpleXML
• Composer
• A web server with URL rewriting capability

Tip

ZAPHYR requires PHP 8.1 as the minimum version. However, we recommend using the latest stable version of PHP for the best experience.

Installation

This guide will walk you through the process of creating a new ZAPHYR application using the skeleton application.

Create application

To create a new application, open a terminal (either Command Prompt or Terminal app, depending on your OS) and run the following Composer command from the directory where you want to install your application:

composer create-project zaphyr-org/app my-app

This command installs a fresh skeleton application in a directory named my-app. Feel free to replace my-app with your desired application name.

Setup and run application

After creating the application, navigate to your application directory (my-app):

cd my-app

Set the APP_URL environment variable in the .env file at the root of your project directory:

APP_URL=http://localhost:8000

To start the built-in PHP web server from the root of your project, run the following command:

php -S localhost:8000 -t public

The application is now running on http://localhost:8000. You can access it in your browser by visiting the URL.

Documentation

Read the full documentation to learn more about the framework.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Issues

Bug reports and feature requests can be submitted on the GitHub Issue Tracker.

Security

If you discover security related issues, please email [e-mail] instead of using the issue tracker!

Contributing

Please see CONTRIBUTING for details.

Code of Conduct

Please see CODE OF CONDUCT for details.

License

This project is licensed under the MIT license. See LICENSE for more information.