kuick/project

There is no license information available for the latest version (v2.4.1) of this package.

v2.4.1 2025-02-13 16:38 UTC

Requires

• kuick/framework: ^2.4

Requires (Dev)

• kuick/qa-toolkit: ^1.0

Unknown License

README

Kuick project is an example application based on Kuick Framework

Key features

1. Ready to install package with sample controllers and commands
2. Dockerfile with targets to test, run and deploy the application

Basic usage

1. With PHP and Composer run:

composer create-project kuick/project .

Alternatively you can just clone this repository.

1. Make sure to have Docker and Make installed

2. Use make to start the dev server

make up

Alternatively you can run the docker commands from the Makefile yourself:

docker build --target=dev-server --tag=kuick-project .
docker run --rm --name kuick-project -v ./:/var/www/html kuick-project composer install
docker run --rm --name kuick-project -v ./:/var/www/html -p 8080:80 -e APP_ENV=dev kuick-project

1. Now you have a local dev server running on 8080 port The source code is directly mounted as a volume into the container, so changes are "live".

Docker Demo

Ready to deploy images you can find on Dockerhub

1. Run using Docker

docker run -p 8080:80 kuickphp/kuick

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

1. Examine those 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 APP_ENV=dev \
    -e APP_NAME=ExampleApp \
    -e APP_CHARSET=UTF-8 \
    -e APP_LOCALE=pl_PL.utf-8 \
    -e APP_TIMEZONE="Europe/Warsaw" \
    -e APP_LOG_USEMICROSECONDS=1 \
    -e APP_LOG_LEVEL=DEBUG \
    -e API_SECURITY_OPS_GUARD_TOKEN=secret-token \
    kuickphp/kuick:alpine

With KUICK_OPS_GUARD_TOKEN defined, you can reach /api/ops endpoint:

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