Skip to content

Commit 6e1d8d9

Browse files
authored
Merge pull request #6 from dotkernel/composer
updated composer, reqs page
2 parents 893f668 + 9ca2b48 commit 6e1d8d9

File tree

4 files changed

+47
-3
lines changed

4 files changed

+47
-3
lines changed

docs/book/v5/installation/composer.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,55 @@
11
# Composer Installation of Packages
22

3+
Composer is required to install Dotkernel `admin`. You can install Composer from the [official site](https://getcomposer.org/).
4+
5+
> First make sure that you have navigated your command prompt to the folder where you copied the files in the previous step.
6+
37
## Install dependencies
48

9+
Run this command in the command prompt.
10+
11+
> Use the **CLI** in order to ensure interactivity for proper configuration.
12+
513
```shell
614
composer install
715
```
816

17+
You should see this text below, along with a long list of packages to be installed instead of the `[...]`.
18+
In this example there are 171 packages, though the number can change in future updates.
19+
You will find the packages in the `vendor` folder.
20+
21+
```shell
22+
No composer.lock file present. Updating dependencies to latest instead of installing from lock file. See https://getcomposer.org/install for more information.
23+
Loading composer repositories with package information
24+
Updating dependencies
25+
Lock file operations: 171 installs, 0 updates, 0 removals
26+
[...]
27+
Writing lock file
28+
Installing dependencies from lock file (including require-dev)
29+
Package operations: 171 installs, 0 updates, 0 removals
30+
[...]
31+
```
32+
33+
The setup script prompts for some configuration settings, for example the lines below:
34+
35+
```shell
36+
Please select which config file you wish to inject 'Laminas\Validator\ConfigProvider' into:
37+
[0] Do not inject
38+
[1] config/config.php
39+
Make your selection (default is 1):
40+
```
41+
42+
Type `0` to select `[0] Do not inject`.
43+
44+
> We choose `0` because Dotkernel includes its own ConfigProvider which already contains the prompted configurations.
45+
> If you choose `[1] config/config.php`, an extra `ConfigProvider` will be injected.
46+
47+
The next question is:
48+
49+
`Remember this option for other packages of the same type? (y/N)`
50+
51+
Type `y` here, and hit `enter` to complete this stage.
52+
953
## Development mode
1054
1155
If you're installing the project for development, make sure you have development mode enabled, by running:

docs/book/v5/installation/test-the-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you are still getting exceptions or errors regarding some missing services, t
2222
2323
- Open a web browser and visit `http://localhost:8080/`
2424

25-
You should see the `DotKernel admin` login page.
25+
You should see the `Dotkernel admin` login page.
2626

2727
If you ran the migrations you will have an admin user in the database with the following credentials:
2828

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Introduction
22

3-
DotKernel web starter package suitable for admin applications.
3+
Dotkernel web starter package suitable for admin applications.

docs/book/v5/introduction/server-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Both mod_php and FCGI (FPM) are supported.
2929

3030
## RDBMS
3131

32-
* MariaDB >= 10.11 LTS
32+
* Tested with MariaDB 10.11 LTS and MariaDB 11.4 LTS
3333

3434
## Recommended extensions
3535

0 commit comments

Comments
 (0)