https://github.com/dotkernel/light
Minimal project to generate a simple website. Simple application using Mezzio microframework and Laminas components.
https://github.com/dotkernel/light
laminas mezzio psr-15
Last synced: 16 days ago
JSON representation
Minimal project to generate a simple website. Simple application using Mezzio microframework and Laminas components.
- Host: GitHub
- URL: https://github.com/dotkernel/light
- Owner: dotkernel
- License: mit
- Created: 2024-09-27T09:23:36.000Z (about 1 year ago)
- Default Branch: 1.0
- Last Pushed: 2025-01-09T13:54:04.000Z (9 months ago)
- Last Synced: 2025-01-09T14:56:37.996Z (9 months ago)
- Topics: laminas, mezzio, psr-15
- Language: PHP
- Homepage: https://light.dotkernel.net/
- Size: 414 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Dotkernel Light
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 our [demo](https://light.dotkernel.net/).
## Documentation
Documentation is available at: https://docs.dotkernel.org/light-documentation/
## Badges
[](https://github.com/dotkernel/light/issues)
[](https://github.com/dotkernel/light/network)
[](https://github.com/dotkernel/light/stargazers)
[](https://github.com/dotkernel/light/blob/1.0/LICENSE)
[](https://github.com/dotkernel/light/actions/workflows/continuous-integration.yml)
[](https://codecov.io/gh/dotkernel/light)
[](https://github.com/dotkernel/light/actions/workflows/qodana_code_quality.yml)
[](https://github.com/dotkernel/light/actions/workflows/static-analysis.yml)
## Installing Dotkernel `light`
- [Installing Dotkernel `light`](#installing-dotkernel-light)
- [Composer](#composer)
- [Choose a destination path for Dotkernel `light` installation](#choosing-an-installation-path-for-dotkernel-light)
- [Installing Dotkernel light](#installing-dotkernel-light)
- [Testing (Running)](#running-the-application)
## Tools
Dotkernel light interface has been tested with npm v10.0.4 and Node.js v20.11.0.
### Composer
Installation instructions:
- [Composer Installation - Linux/Unix/OSX](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)
- [Composer Installation - Windows](https://getcomposer.org/doc/00-intro.md#installation-windows)
> If you have never used composer before make sure you read the [`Composer Basic Usage`](https://getcomposer.org/doc/01-basic-usage.md) section in Composer's documentation
## Choosing an installation path for Dotkernel `light`
Example:
- absolute path `/var/www/dk`
- or relative path `dk` (equivalent with `./dk`)
## Installing Dotkernel `light`
After you choose the path for Dotkernel light (`dk` will be used for the remainder of this example), let's move onto installation.
### Installing Dotkernel `light` using git clone
This method ensures that the default branch is installed, even if it is not released. Run the following command:
```shell
git clone https://github.com/dotkernel/light.git .
```
The dependencies have to be installed separately, by running this command:
```shell
composer install
```
The setup script prompts for some configuration settings, for example the lines below:
```shell
Please select which 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's `ConfigProvider` will be injected.
The next question is:
`Remember this option for other packages of the same type? (Y/n)`
You should enter `y` and press `Enter`.
## Development mode
Run this command to enable dev mode by turning debug flag to `true` and turning configuration caching to `off`. It will also make sure that any existing config cache is cleared.
```shell
composer development-enable
```
- If not already done, remove the `.dist` extension from `config/autoload/development.local.php.dist`.
## Bundling Static Modules
> Prerequisite software: Node.js v20 (minimum supported version)
To install dependencies into the `node_modules` directory run this command.
```shell
npm install
```
If `npm install` fails, this could be caused by user permissions of npm.
We recommend installing npm through `Node Version Manager`.
> You can skip the next step until you make changes in the `src/App/assets` folder
The build command compiles the components from the `src/App/assets` folder into the `public` folder.
> This command overwrites existing files in the `public` folder.
```shell
npm run build
```
## Running the application
We recommend running your applications in WSL:
- make sure you have [WSL](https://github.com/dotkernel/development/blob/main/wsl/README.md) installed on your system
- currently we provide a distro implementations for [AlmaLinux9](https://github.com/dotkernel/development/blob/main/wsl/os/almalinux9/README.md)
- install the application in a virtualhost as recommended by the chosen distro
- set `$baseUrl` in **config/autoload/local.php** to the address of the virtualhost
- run the application by opening the virtualhost address in your browser
You should see the `Dotkernel light` welcome page.
**NOTE:**
- If you are getting exceptions or errors regarding some missing services, try running the following command:
```shell
sudo php bin/clear-config-cache.php
```
> If `config-cache.php` is present that config will be loaded regardless of the `ConfigAggregator::ENABLE_CACHE` in `config/autoload/mezzio.global.php`