kuick/framework

Kuick is an extremely low footprint application framework, suitable for high throughput workloads

v1.0.9 2024-12-01 11:39 UTC

This package is auto-updated.

Last update: 2024-12-03 14:43:07 UTC


README

Latest Version PHP Total Downloads GitHub Actions CI codecov Software License

Kuick is an extremely low footprint PHP application framework, based on Symfony components, suitable for high workloads Designed for developers seeking speed, efficiency, and flexibility in web application development.

Usage (Docker)

Ready to deploy images you can find here: https://hub.docker.com/r/kuickphp/kuick/tags

  1. Run using Docker This example utilizes the smallest, Alpine distribution.
docker run -p 8080:80 kuickphp/kuick:1.0-alpine

Now you can try it out by opening http://localhost:8080/

  1. Examine sample routes:
  • Homepage:
curl http://localhost:8080/
  • Hello/ping:
curl http://localhost:8080/hello/John
  1. Container runtime configuration:
  • dev mode enabled
  • custom app name
  • custom localization (charset, locale, timezone)
  • DEBUG log with microtime
  • custom OPS API token
docker run -p 8080:80 \
    -e KUICK_APP_ENV=dev \
    -e KUICK_APP_NAME=ExampleApp \
    -e KUICK_APP_CHARSET=UTF-8 \
    -e KUICK_APP_LOCALE=pl_PL.utf-8 \
    -e KUICK_APP_TIMEZONE="Europe/Warsaw" \
    -e KUICK_APP_MONOLOG.USEMICROSECONDS=1 \
    -e KUICK_APP_MONOLOG_LEVEL=DEBUG \
    -e KUICK_OPS_GUARD_TOKEN=secret-token \
    kuickphp/kuick:1.0-alpine

OPS endpoint:

curl -H "Authorization: Bearer secret-token" http://localhost:8080/api/ops

Usage (Standalone)

  1. Install PHP>8.2 + Composer @TODO: finish this chapter