KISSCore

What is it?

KISSCore Microframework on PHP 8+ is the lightweight single file packed end-project framework for rapid development of very fast projects.

Single core file in project you create
Simple and very fast template engine that allows you to use only blocks and iterations (easy to learn for designers)
Fast routes that convert to nginx rewrite on init. Live route table in action files just with a single comment
Minimum dependency and maximum profit
Plugins with a nice approach for easy extension
Deploy script to production servers in parallel!

Installation guide

Get KISS Core package

Just clone it from git:

git clone [email protected]:muvon/kisscore.git

New application

First you should update your php-fpm and nginx global config to include projects files. Add the following lines to php-fpm config:

include = /home/*/*/env/etc/php-fpm.conf

And the following lines for nginx config:

include /home/*/*/env/etc/nginx.conf;

Now you can create application with single command in KISS Core dir:

./create-app ~/Work/myproj

That will create your application in folder myproj under home dir, prepare all it environment in local machine and restart php-fpm and nginx. So be sure that you correctly configured your php-fpm and nginx on your server like I wrote before.

Setup domain for local test:

sudo echo '127.0.0.1 myproj.lo' >> /etc/hosts

Restart services nginx and php-fpm and enjoy in you browser opening your project http://myproj.lo

Running using Docker containers

You can simple run newly created project using Yoda with Docker. Just install Yoda, change dir of your current project and run in your bash shell:

yoda start

Update core in existing application

You also can update compiled KISSCore file in your application. Just run install-core and enjoy!

./install-core [arguments] ~/Work/myproj

Where arguments are:

--with-plugins - Install core plugins

Folder structure

Root folders structure

Folder	Description
app	Main project folder with source code, libraries, static and KISSCore
docker	This folder contains Yoda configs to start project using docker containers
env	Environment folder with tmp files, generated maps, configs and other special env stuff

app skeleton

Folder	Description	Namespace
actions	Action dir, it contains of action files that includes on route
bin	Special bash scripts and bin files
config	Config folder with all configs templates and main: app.yml.tpl
core.php	Core file with merged KISSCore classes and functions
frontend.php	That files handle all nginx dynamic requests (front point)
lib	Library sources that does not depend on KISSCore	Lib
main.php	Thats is type of front controller, but just a simple flat file
src	All your source code, structured as you want	App
static	Root nginx dir for static files
triggers	Special triggers. It contains flat files with some annotation
vendor	Thrird party libraries namespaced with PSR-4	All other not included before
views	Templates for rendering from action

env skeleton

Folder	Description
bin	Symlink to app/bin
etc	Generated configs that uses by application and services
files	Static files. You can use it just a like storage
log	All logs go here
run	Pid files with running processes, some special files that depends on run
tmp	It contains temporary files
var	Some application data, configured maps and so on

Environment variables

Must be set by you:

$APP_ENV - current environment

And this is autodetected by KISSCore:

$APP_DIR - application dir with code
$ENV_DIR - environment dir
$RUN_DIR - run directory (pid files of running processes and so on)
$VAR_DIR - Var dir
$TMP_DIR - for temp files
$LOG_DIR - all logs from project collect here
$CONFIG_DIR - configuration files
$BIN_DIR - for special bin files and scripts
$STATIC_DIR - public directory for static files

Plugins

There are core plugins that may be purged at the stage of installing core. You can simply pass the --with-plugins flag to the install-core script to install them. We are working on making them more modular and easy to use.

Libs

Libs are independent and lightweight modules with no direct coupling to kisscore. These can be installed separately using the --with-libs flag during the installation process. Unlike plugins, libs are designed to be more versatile and can be used across different projects without heavy dependencies on the core system.

Actions

All actions are in app/actions folder. You should just create any file, for example test.php and put code in it.

<?php
/**
 * @route test
 * @param string $hello
 */

return 'Hello';

If action returns 1 as integer or no return statement then kisscore will try to include same name template and render it using View. If action returns string then it will be rendered as is. If action returns object or array then it will be rendered as json encoded string.

Reinit your app and open in project http://myproj/test that will execute this action.

Triggers

There are special functionality to trigger some event, catch it and do something. It works like hooks. First you call trigger_event('test', ['var' => 'test']) in any place of your code. Then you create special trigger file in app/triggers folder. Annotate trigger with special comments, for example:

<?php
/**
 * @trigger test
 * @param string $var
 */
 echo $var;

Prepare environment with init call and thats finally done. You now can trigger_event and see the result of var you passed in data of event.

Dependency

To run project using KISS Core you need

Only PHP 8+ to run php code :)

to handle web requests

Yoda for isolation using Docker

to handle web requests with ease with automated launch and easy deployment system ;)

And also some linux knowledge ;)

How to extend?

Just use lib dir into your application folder. You can put there any external module and use it into your project, KISS core allow you to start MVC fast application in just couple of minutes with minimum dependencies. But you can extends it infinite for sure :) Just try Keep It Simple as possible!

Nginx + FPM vs Swoole

Nginx + FPM:

$ wrk -t4 -c1000 -d60s http://localhost:8081
Running 1m test @ http://localhost:8081
  4 threads and 1000 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency    64.85ms    7.30ms 152.15ms   75.87%
    Req/Sec     3.87k   212.05     4.33k    79.25%
  924571 requests in 1.00m, 672.74MB read
Requests/sec:  15390.93
Transfer/sec:     11.20MB

Swoole:

$ wrk -t4 -c1000 -d60s http://localhost:8082
Running 1m test @ http://localhost:8082
  4 threads and 1000 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency    50.70ms    7.43ms 221.96ms   72.00%
    Req/Sec     4.96k   303.62     5.63k    80.38%
  1183738 requests in 1.00m, 0.91GB read
Requests/sec:  19705.32
Transfer/sec:     15.47MB

As compared to wrk, the Swoole version is around 28% faster than Nginx with FPM, and it also requires fewer services to run.

More?

Feel free to ask me any question!

muvon / kisscore Goto Github PK

kisscore's Introduction