Skip to content

Commit 036e057

Browse files
authored
Merge pull request #95 from dotkernel/readme
Readme, package.json
2 parents e7f8f20 + b92eabc commit 036e057

5 files changed

Lines changed: 30 additions & 79 deletions

File tree

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,20 @@ Documentation is available at: https://docs.dotkernel.org/light-documentation/
2626
[![PHPStan](https://github.com/dotkernel/light/actions/workflows/static-analysis.yml/badge.svg?branch=1.0)](https://github.com/dotkernel/light/actions/workflows/static-analysis.yml)
2727
![PHPstan Level](https://img.shields.io/badge/PHPStan-level%208-brightgreen)
2828

29-
## Installing Dotkernel `light`
29+
## Installing Dotkernel `Light`
3030

31-
- [Installing Dotkernel `light`](#installing-dotkernel-light)
31+
- [Installing Dotkernel `Light`](#installing-dotkernel-light)
3232
- [Composer](#composer)
33-
- [Choose a destination path for Dotkernel `light` installation](#choosing-an-installation-path-for-dotkernel-light)
33+
- [Choose a destination path for Dotkernel `Light` installation](#choosing-an-installation-path-for-dotkernel-light)
3434
- [Installing Dotkernel light](#installing-dotkernel-light)
3535
- [Testing (Running)](#running-the-application)
3636

3737
## Tools
3838

39-
Dotkernel light interface has been tested with npm v10.0.4 and Node.js v20.11.0.
39+
Dotkernel light interface has been tested with:
40+
41+
- npm versions: v10.0.4, v10.9.8, v11.13.0.
42+
- Node.js versions: v20.11.0, v22.22.3, v24.16.0.
4043

4144
### Composer
4245

@@ -45,28 +48,28 @@ Installation instructions:
4548
- [Composer Installation - Linux/Unix/OSX](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)
4649
- [Composer Installation - Windows](https://getcomposer.org/doc/00-intro.md#installation-windows)
4750

48-
> 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
51+
> 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.
4952
50-
## Choosing an installation path for Dotkernel `light`
53+
## Choosing an Installation Path for Dotkernel `Light`
5154

5255
Example:
5356

5457
- absolute path `/var/www/dk`
5558
- or relative path `dk` (equivalent with `./dk`)
5659

57-
## Installing Dotkernel `light`
60+
## Installing Dotkernel `Light`
5861

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

61-
### Installing Dotkernel `light` using git clone
64+
### Installing Dotkernel `Light` Using `git clone`
6265

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

6568
```shell
6669
git clone https://github.com/dotkernel/light.git .
6770
```
6871

69-
The dependencies have to be installed separately, by running this command:
72+
The dependencies have to be installed separately by running this command:
7073

7174
```shell
7275
composer install
@@ -91,7 +94,7 @@ The next question is:
9194
9295
You should enter `y` and press `Enter`.
9396
94-
## Development mode
97+
## Development Mode
9598
9699
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.
97100
@@ -124,17 +127,17 @@ The build command compiles the components from the `src/App/assets` folder into
124127
npm run build
125128
```
126129
127-
## Running the application
130+
## Running the Application
128131
129132
We recommend running your applications in WSL:
130133
131-
- make sure you have [WSL](https://github.com/dotkernel/development/blob/main/wsl/README.md) installed on your system
132-
- currently we provide a distro implementations for [AlmaLinux9](https://github.com/dotkernel/development/blob/main/wsl/os/almalinux9/README.md)
133-
- install the application in a virtualhost as recommended by the chosen distro
134-
- set `$baseUrl` in **config/autoload/local.php** to the address of the virtualhost
135-
- run the application by opening the virtualhost address in your browser
134+
- Make sure you have [WSL](https://github.com/dotkernel/development/blob/main/wsl/README.md) installed on your system.
135+
- Currently we provide a distro implementation for [AlmaLinux10](https://docs.dotkernel.org/development/v2/setup/installation/).
136+
- Install the application in a virtualhost as recommended by the chosen distro.
137+
- Set `$baseUrl` in **config/autoload/local.php** to the address of your virtualhost.
138+
- Run the application by opening the virtualhost address in your browser.
136139
137-
You should see the `Dotkernel light` welcome page.
140+
You should see the `Dotkernel Light` welcome page.
138141
139142
**NOTE:**
140143

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
"ts-loader": "^9.5.1",
4747
"typescript": "^6.0.0",
4848
"vite": "^8.0.0",
49-
"vite-plugin-static-copy": "^2.3.1"
49+
"vite-plugin-static-copy": "^4.1.0"
5050
},
5151
"dependencies": {
5252
"@babel/core": "^7.26.9",

public/css/app.css

Lines changed: 1 addition & 42 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

public/js/app.js

Lines changed: 4 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vite.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ export default defineConfig({
1111
targets: [
1212
{
1313
src: 'App/assets/fonts/*',
14-
dest: 'fonts'
14+
dest: 'fonts',
15+
rename: { stripBase: true },
1516
},
1617
{
1718
src: 'App/assets/images/*',
18-
dest: 'images/app/'
19+
dest: 'images/app/',
20+
rename: { stripBase: true },
1921
},
2022
],
2123
}),

0 commit comments

Comments
 (0)