Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/razshare/catpaw
An opinionated dependency injection library for amphp.
https://github.com/razshare/catpaw
Last synced: about 1 month ago
JSON representation
An opinionated dependency injection library for amphp.
- Host: GitHub
- URL: https://github.com/razshare/catpaw
- Owner: razshare
- License: mit
- Created: 2022-01-02T14:52:38.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T01:12:13.000Z (7 months ago)
- Last Synced: 2024-05-28T13:28:23.063Z (7 months ago)
- Language: PHP
- Homepage: https://github.com/tncrazvan/catpaw
- Size: 52.5 MB
- Stars: 15
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# What is this?
Catpaw is an opinionated dependency injection library that comes with batteries included for developing asynchronous and declarative general purpose programs.\
It leverages [php attributes](https://www.php.net/manual/en/language.attributes.overview.php) to provide declarative apis, and the [amphp](https://github.com/amphp/amp) platform to make your program asynchronous.
| Table of Contents | Description |
|-------------------------------------------------------------------|-------------|
| ⚡ [Container](./docs/Container.md) | Provide dependencies and retrieve them. |
| ⚡ [Error Management](./docs/Error%20Management.md) | Manage errors. |
| 🌐 [Server Router](./docs/Server%20Router.md) | Create a server and define routes. |
| 🌐 [Server Path Parameters](./docs/Server%20Path%20Parameters.md) | Define path parameters in your routes. |
| 🌐 [Server Open Api](./docs/Server%20Open%20Api.md) | Generate an Open Api definition. |
| 🌐 [Server Session](./docs/Server%20Session.md) | Create and manage server sessions. |
| 🌐 [Server Websockets](./docs/Server%20Websockets.md) | Serve websockets. |
| ⚡ [Entry](./docs/Entry.md) | Execute code when a dependency is resolved. |
| ⚡ [Command](./docs/Command.md) | Create a console command. |
| ⚡ [Stores](./docs/Stores.md) | Store data in memory and react to changes in said data. |
| ⚡ [Queues](./docs/Queues.md) | Create in memory queues and tag them. |
| ⚡ [Schedule](./docs/Schedule.md) | Schedule code execution using a human readable format. |
| ⚡ [Signals](./docs/Signals.md) | Create signals and react to them. |
| ⚡ [Build](./docs/Build.md) | Build your project into one single portable file. |
| 💡 [RaspberryPi](./docs/RaspberryPi.md) | Control your RaspberryPi's GPIOs. |
> [!NOTE]
> This project is aimed at linux distributions, some features may or not may work on Windows and/or MacOS.\
> Feel free to contribute fixing issues for specific platforms.
# Get started
You will need at least [php 8.3](https://www.php.net/downloads.php) and the `php-mbstring` extension (required for PHPUnit).
Create a new project using one of the starter templates.
- you can start from scratch
```bash
composer create-project catpaw/starter
```
- you can start with a web server
```bash
composer create-project catpaw/web-starter
```
---
Every application must declare a `main` function in the global scope, that will be your entry point:
```php
info("hello world");
}
```
After you've created your new project, you can run it using
```bash
composer dev:watch
```
to watch file changes (useful in development)
or
```bash
composer prod:start
```
for production mode.
# Build & Run
It is possible, but not required, to build your application into a single `.phar` file using
```bash
composer prod:build
```
The building process can be configured inside the `build.ini` file.
After building your application, you can simply run it using
```
php app.phar
```
The resulting `.phar`, by default (check `build.ini`), includes the following directories:
- `./src`
- `./vendor`
- `./bin`
- `./.build-cache` (created at build time)
which means it's a portable binary, you just need to make
sure php is installed on whatever machine you're trying to run it on.
# Debugging with VSCode
- Install xdebug
```php
apt install php8.3-xdebug
```
- Put this configuration in your `./.vscode/launch.json` file
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch",
"type": "php",
"request": "launch",
"program": "${workspaceRoot}/bin/start",
"args": [
"--libraries='./src/lib'",
"--entry='./src/main.php'"
],
"cwd": "${workspaceRoot}",
"runtimeArgs": [
"-dxdebug.start_with_request=yes"
],
"env": {
"XDEBUG_MODE": "debug,develop",
"XDEBUG_CONFIG": "client_port=${port}"
}
},
{
"name": "Listen",
"type": "php",
"request": "launch",
"port": 9003
}
]
}
```
- Start debugging