Skip to content

Commit

Permalink
Merge pull request #6 from dotkernel/composer
Browse files Browse the repository at this point in the history
updated composer, reqs page
  • Loading branch information
arhimede authored Nov 1, 2024
2 parents 893f668 + 9ca2b48 commit 6e1d8d9
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 3 deletions.
44 changes: 44 additions & 0 deletions docs/book/v5/installation/composer.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,55 @@
# Composer Installation of Packages

Composer is required to install Dotkernel `admin`. You can install Composer from the [official site](https://getcomposer.org/).

> First make sure that you have navigated your command prompt to the folder where you copied the files in the previous step.
## Install dependencies

Run this command in the command prompt.

> Use the **CLI** in order to ensure interactivity for proper configuration.
```shell
composer install
```

You should see this text below, along with a long list of packages to be installed instead of the `[...]`.
In this example there are 171 packages, though the number can change in future updates.
You will find the packages in the `vendor` folder.

```shell
No composer.lock file present. Updating dependencies to latest instead of installing from lock file. See https://getcomposer.org/install for more information.
Loading composer repositories with package information
Updating dependencies
Lock file operations: 171 installs, 0 updates, 0 removals
[...]
Writing lock file
Installing dependencies from lock file (including require-dev)
Package operations: 171 installs, 0 updates, 0 removals
[...]
```

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

```shell
Please select which config file you wish to inject 'Laminas\Validator\ConfigProvider' into:
[0] Do not inject
[1] config/config.php
Make your selection (default is 1):
```
Type `0` to select `[0] Do not inject`.
> We choose `0` because Dotkernel includes its own ConfigProvider which already contains the prompted configurations.
> If you choose `[1] config/config.php`, an extra `ConfigProvider` will be injected.
The next question is:
`Remember this option for other packages of the same type? (y/N)`
Type `y` here, and hit `enter` to complete this stage.
## Development mode
If you're installing the project for development, make sure you have development mode enabled, by running:
Expand Down
2 changes: 1 addition & 1 deletion docs/book/v5/installation/test-the-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you are still getting exceptions or errors regarding some missing services, t
- Open a web browser and visit `http://localhost:8080/`

You should see the `DotKernel admin` login page.
You should see the `Dotkernel admin` login page.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/book/v5/introduction/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Introduction

DotKernel web starter package suitable for admin applications.
Dotkernel web starter package suitable for admin applications.
2 changes: 1 addition & 1 deletion docs/book/v5/introduction/server-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Both mod_php and FCGI (FPM) are supported.

## RDBMS

* MariaDB >= 10.11 LTS
* Tested with MariaDB 10.11 LTS and MariaDB 11.4 LTS

## Recommended extensions

Expand Down

0 comments on commit 6e1d8d9

Please sign in to comment.