Skip to content

Commit 1f9fb92

Browse files
committed
updated installation pages
Signed-off-by: bidi <bidi@apidemia.com>
1 parent 292676c commit 1f9fb92

File tree

3 files changed

+51
-5
lines changed

3 files changed

+51
-5
lines changed

docs/book/v7/installation/composer.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,30 @@ Run this command in the command prompt.
1414
composer install
1515
```
1616

17+
The automatic setup script performs these tasks:
18+
19+
- Installs the packages listed in the `composer.json` file and their dependencies into the `vendor` folder.
20+
- Creates the `composer.lock` file that locks all dependencies to exact versions (you can still run `composer update` to replace them with newer versions, if available).
21+
- Configures PHP CodeSniffer, a utility to detect code style errors in PHP code.
22+
- Generate and save the OAuth2 keys in the `data/oauth` folder.
23+
- Creates the initial `config/autoload` configuration files:
24+
- config/autoload/local.php
25+
- config/autoload/local.test.php
26+
- config/autoload/mail.global.php
27+
1728
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 164 packages, though the number can change in future updates.
19-
You will find the packages in the newly-created `vendor` folder.
29+
30+
> In this example there are 146 packages, though the number can change in future updates.
2031
2132
```shell
2233
No composer.lock file present. Updating dependencies to latest instead of installing from lock file. See https://getcomposer.org/install for more information.
2334
Loading composer repositories with package information
2435
Updating dependencies
25-
Lock file operations: 164 installs, 0 updates, 0 removals
36+
Lock file operations: 146 installs, 0 updates, 0 removals
2637
[...]
2738
Writing lock file
2839
Installing dependencies from lock file (including require-dev)
29-
Package operations: 164 installs, 0 updates, 0 removals
40+
Package operations: 146 installs, 0 updates, 0 removals
3041
[...]
3142
```
3243

@@ -60,6 +71,12 @@ Enable development mode by running:
6071
composer development-enable
6172
```
6273
74+
The confirmation message should read:
75+
76+
```shell
77+
You are now in development mode.
78+
```
79+
6380
If you ever need to disable the development mode, run:
6481
6582
```shell

docs/book/v7/installation/doctrine-orm.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,22 @@ To execute fixtures, run:
170170
php ./bin/doctrine fixtures:execute
171171
```
172172

173+
If everything ran correctly, you will get this confirmation:
174+
175+
```shell
176+
Executing Core\App\Fixture\AdminRoleLoader
177+
Executing Core\App\Fixture\OAuthClientLoader
178+
Executing Core\App\Fixture\OAuthScopeLoader
179+
Executing Core\App\Fixture\UserRoleLoader
180+
Executing Core\App\Fixture\AdminLoader
181+
Executing Core\App\Fixture\UserLoader
182+
Fixtures have been loaded.
183+
.''
184+
._.-.___.' (`\
185+
//( ( `'
186+
'/ )\ ).__. )
187+
' <' `\ ._/'\
188+
` \ \
189+
```
190+
173191
More details on how fixtures work can be found on [dot-data-fixtures documentation](https://github.com/dotkernel/dot-data-fixtures#usage)

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,29 @@
22

33
> If you are getting server error 500, make sure to check the folder permissions covered in the [FAQ page](https://docs.dotkernel.org/api-documentation/v7/installation/faq/)
44
5-
Sending a GET request to the [home page](http://0.0.0.0:8080/) should output the following message:
5+
Sending a GET request to the home page for your virtual host should output the following message:
66

77
```json
88
{"message": "Dotkernel API version 7"}
99
```
1010

11+
From this point on, you are ready to add custom code to your application.
12+
1113
## Old way of doing things, using PHP built-in server
1214

15+
This is an alternative way of accessing the API, without using a virtual host.
16+
Run this command from the project root:
17+
1318
```shell
1419
php -S 0.0.0.0:8080 -t public
1520
```
1621

22+
You should see something like this:
23+
24+
```shell
25+
[Mon Mar 30 14:53:50 2026] PHP 8.4.15 Development Server (http://0.0.0.0:8080) started
26+
```
27+
1728
## Running tests
1829

1930
The project has two types of tests: functional and unit tests, you can run both types at the same type by executing this command:

0 commit comments

Comments
 (0)