Repository files navigation

Dotkernel Light is a PSR-15 compliant application (skeleton) using Mezzio microframework and Laminas components.It's designed as a minimal project to generate a simple website, like a presentation site.

Check out ourdemo.

Documentation is available at:https://docs.dotkernel.org/light-documentation/

• Installing Dotkernellight
  • Composer
  • Choose a destination path for Dotkernellight installation
  • Installing Dotkernel light
  • Testing (Running)

Dotkernel light interface has been tested with npm v10.0.4 and Node.js v20.11.0.

Installation instructions:

• Composer Installation - Linux/Unix/OSX
• Composer Installation - Windows

If you have never used composer before make sure you read theComposer Basic Usage section in Composer's documentation

Example:

• absolute path/var/www/dk
• or relative pathdk (equivalent with./dk)

After you choose the path for Dotkernel light (dk will be used for the remainder of this example), let's move onto installation.

This method ensures that the default branch is installed, even if it is not released. Run the following command:

git clone https://github.com/dotkernel/light.git.

The dependencies have to be installed separately, by running this command:

composer install

The setup script prompts for some configuration settings, for example the lines below:

Pleaseselectwhich config file you wish to inject'Laminas\HttpHandlerRunner\ConfigProvider' into:  [0] Do not inject  [1] config/config.php  Make your selection (default is 1):

Simply select[0] Do not inject, because Dotkernel includes its own configProvider which already contains the prompted configurations.

If you choose[1] config/config.php Laminas'sConfigProvider will be injected.

The next question is:

Remember this option for other packages of the same type? (Y/n)

You should entery and pressEnter.

Run this command to enable dev mode by turning debug flag totrue and turning configuration caching tooff. It will also make sure that any existing config cache is cleared.

composer development-enable

• If not already done, remove the.dist extension fromconfig/autoload/development.local.php.dist.

Prerequisite software: Node.js v20 (minimum supported version)

To install dependencies into thenode_modules directory run this command.

npm install

Ifnpm install fails, this could be caused by user permissions of npm.We recommend installing npm throughNode Version Manager.

You can skip the next step until you make changes in thesrc/App/assets folder

The build command compiles the components from thesrc/App/assets folder into thepublic folder.

This command overwrites existing files in thepublic folder.

npm run build

We recommend running your applications in WSL:

• make sure you haveWSL installed on your system
• currently we provide a distro implementations forAlmaLinux9
• install the application in a virtualhost as recommended by the chosen distro
• set$baseUrl inconfig/autoload/local.php to the address of the virtualhost
• run the application by opening the virtualhost address in your browser

You should see theDotkernel light welcome page.

NOTE:

• If you are getting exceptions or errors regarding some missing services, try running the following command:

sudo php bin/clear-config-cache.php

Ifconfig-cache.php is present that config will be loaded regardless of theConfigAggregator::ENABLE_CACHE inconfig/autoload/mezzio.global.php