wwbyte/framework

Lightweight PHP framework based on OpenSwoole.

dev-master 2024-12-04 12:13 UTC

Requires

• php: ^8.2
• dragonmantank/cron-expression: ^3.3
• openswoole/core: dev-master
• openswoole/ide-helper: dev-master
• phpunit/phpunit: ^9.6
• psr/container: ^2.0
• psr/event-dispatcher: ^1.0@dev
• psr/http-message: ^1.0
• psr/http-server-handler: ^1.0@dev
• psr/http-server-middleware: ^1.0@dev
• psr/log: ^3.0@dev

Requires (Dev)

• php-webdriver/webdriver: ^1.15
• squizlabs/php_codesniffer: 4.0.x-dev

MPL-2.0

• Elar Must

README

A lightweight PHP server framework powered by OpenSwoole, integrating MVC architecture and WebSockets within a single server instance.
One of the key features is its modularity, allowing you to extend its functionality by creating custom modules.

Note: This project is currently under development, and some features may not work as expected. Feel free to explore and contribute, but be aware that the codebase is subject to changes.

General requirements

• MySQL database
• Docker
• WSL is required when running on Windows

Installation via Docker

Start by cloning the project with

git clone https://github.com/elarmust/PHP-Server-Framework.git

Copy docker-examples to docker.

cp docker-examples/* docker/

You may modify the Dockerfile and docker-compose.yml according to your needs.

Before the Docker container is started, rename config-example.json to config.json and edit config.json with valid MySQL connection information. If you've renamed any of the containers, be sure to reflect these changes in the following commands.
Start the Docker containers and run basic migrations with

cd docker
docker compose up -d
docker attach framework-framework-1
migrate run up all

When running on Docker, you can communicate with the Framework process with:

docker attach framework-framework-1

Contributing

If you'd like to contribute, you can do the following:

• Create a fork and submit a pull request or
• Submit an issue or feature request

TO DO list

• Cron improvement
• Add command arguments to unit tests and fix some errors
• Better CLI and fix an error thrown, when invalid command is used.
• XML and YML configuration support maybe.