Skip to content

Commit 2474cc2

Browse files
author
DKravtsov
committed
Updated docs and configuration.
1 parent b5450b7 commit 2474cc2

27 files changed

+88
-76
lines changed

.idea/externalDependencies.xml

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

.idea/php-test-framework.xml

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

.idea/php.xml

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

docs/development.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,18 +135,18 @@ make phpcpd-html-report
135135
```
136136

137137
### Composer tools
138-
To normalize or validate your composer.json you can use next local shell commands:
138+
To normalize or validate your composer.json, you can use next local shell commands:
139139
```bash
140140
make composer-normalize
141141
make composer-validate
142142
```
143143

144-
If you need to find unused packages by scanning your code you can use next local shell commands:
144+
If you need to find unused packages by scanning your code, you can use next local shell commands:
145145
```bash
146146
make composer-unused
147147
```
148148

149-
In order to check the defined dependencies against your code you can use next local shell commands:
149+
In order to check the defined dependencies against your code, you can use next local shell commands:
150150
```bash
151151
make composer-require-checker
152152
```
@@ -157,7 +157,7 @@ Use next local shell command in order to run it:
157157
```bash
158158
make phpmetrics
159159
```
160-
Note: You need run tests before this local shell command.
160+
Note: You need to run tests before this local shell command.
161161

162162
After execution above local shell command please open `reports/phpmetrics/index.html` with your browser.
163163

@@ -203,7 +203,7 @@ Please use next workflow for migrations:
203203

204204
Above commands you can run in symfony container shell using next: `./bin/console doctrine:migrations:<command>`.
205205

206-
Using above workflow allow you make database changes on your application.
206+
Using above workflow allows you make database changes on your application.
207207
Also you do not need to make any migrations files by hand (Doctrine will handle it).
208208
Please always check generated migration files to make sure that those doesn't contain anything that you really don't want.
209209

docs/images/phpstorm_01.png

-27.1 KB
Loading

docs/images/phpstorm_02.png

12.6 KB
Loading

docs/images/phpstorm_03.png

-18 KB
Loading

docs/images/phpstorm_04.png

10.6 KB
Loading

docs/images/phpstorm_05.png

6.37 KB
Loading

docs/images/phpstorm_06.png

-7.52 KB
Loading
7.53 KB
Loading
-1.33 KB
Loading
8.63 KB
Loading
-690 Bytes
Loading

docs/images/phpstorm_phpmd_1.png

8.18 KB
Loading

docs/images/phpstorm_phpmd_2.png

-827 Bytes
Loading

docs/images/phpstorm_phpstan_1.png

7.38 KB
Loading

docs/images/phpstorm_phpstan_2.png

-990 Bytes
Loading

docs/images/xdebug_01.png

53.5 KB
Loading

docs/images/xdebug_02.png

74.8 KB
Loading

docs/messenger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Messenger
2-
This document describing how you can use [symfony/messenger](https://symfony.com/doc/current/messenger.html) bundle inside this environment.
2+
This document describing how you can use [symfony/messenger](https://symfony.com/doc/current/messenger.html) bundle.
33

44
## Basics
55

docs/phpstorm.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,20 @@ This document describing how you can configure your IDE [PhpStorm](https://www.j
44
## Configuring PhpStorm
55
### General
66
* Go to `Settings -> Plugins` and install next plugins:
7-
- .env files support
87
- .ignore
9-
- Elasticsearch (Paid)
10-
- Makefile Language
118
- Php Annotations
129
- Php Inspections (EA Extended)
1310
- Php Toolbox
14-
- Symfony support (Has some paid functions, [homepage](https://espend.de/phpstorm/plugin/symfony))
15-
- Rainbow brackets
11+
- JetBrains AI Assistant
12+
- Symfony Plugin (Has some paid functions, [homepage](https://espend.de/phpstorm/plugin/symfony))
13+
- Rainbow Brackets
1614
- String Manipulation
17-
- Extra ToolWindow Colorful Icons
15+
- Elasticsearch (Paid)
1816
* Go to `Settings -> Php -> Symfony` and check `Enable plugin for this project` and set Web Directory value as `public`.
19-
* If you want control quality of your PHP project - pay your attention to the tools, described [here](development.md).
17+
* If you want to control quality of your PHP project - pay your attention to the tools, described [here](development.md).
2018

2119
### CLI Interpreter
22-
You need to set correct CLI interpreter for your PhpStorm.
20+
You need to set a correct CLI interpreter for your PhpStorm.
2321
In order to do it please open `Settings -> PHP` section and follow recommendations [configuring remote PHP interpreters](https://www.jetbrains.com/help/phpstorm/configuring-remote-interpreters.html).
2422

2523
![Path mappings](images/phpstorm_00.png)
@@ -37,7 +35,7 @@ You need to configure how your local files will be mapped inside docker containe
3735
![Path mappings](images/phpstorm_03.png)
3836

3937
### Test Frameworks
40-
If you want to run tests directly from your IDE you need to do following configuration in `Settings -> PHP -> Test Frameworks`:
38+
If you want to run tests directly from your IDE you need to do a following configuration in `Settings -> PHP -> Test Frameworks`:
4139

4240
![Path mappings](images/phpstorm_04.png)
4341

@@ -63,30 +61,30 @@ Anyway you can always import our recommended code style if you don't have commit
6361
![Path mappings](images/phpstorm_php_code_sniffer_2.png)
6462
![Path mappings](images/phpstorm_php_cs_fixer_1.png)
6563

66-
Note: make sure that you have proper local path for the PHP CS Fixer ruleset `.php-cs-fixer.dist.php`.
64+
Note: make sure that you have a proper local path for the PHP CS Fixer ruleset `.php-cs-fixer.dist.php`.
6765

6866
![Path mappings](images/phpstorm_php_cs_fixer_2.png)
6967
![Path mappings](images/phpstorm_phpstan_1.png)
7068
![Path mappings](images/phpstorm_phpstan_2.png)
7169
![Path mappings](images/phpstorm_phpmd_1.png)
7270

73-
Note: make sure that you have proper local path for the MessDetector ruleset `phpmd_ruleset.xml`.
71+
Note: make sure that you have a proper local path for the MessDetector ruleset `phpmd_ruleset.xml`.
7472

7573
![Path mappings](images/phpstorm_phpmd_2.png)
7674

7775
* If you don't have committed folder `.idea/`, go to `Settings -> Editor -> Inspections` and import profile `Project Default` (Inspections.xml) from [docs/phpstorm](phpstorm):
7876

7977
![Path mappings](images/phpstorm_inspections.png)
8078

81-
* Go to `Settings -> Tools -> External tools` and create ecs tool:
79+
* Go to `Settings -> Tools -> External Tools` and create ecs tool:
8280

8381
![Path mappings](images/phpstorm_12.png)
8482

8583
Note: Arguments value should be `exec-bash cmd="./vendor/bin/ecs --clear-cache check $FilePathRelativeToProjectRoot$"`.
8684

8785
Note: In order to use it - right click on the necessary file/folder in PhpStorm and select context menu `External Tools -> ecs`.
8886

89-
* Go to `Settings -> Tools -> External tools` and create phpcs tool:
87+
* Go to `Settings -> Tools -> External Tools` and create phpcs tool:
9088

9189
![Path mappings](images/phpstorm_13.png)
9290

@@ -95,7 +93,7 @@ Note: Arguments value should be `exec-bash cmd="./vendor/bin/phpcs --version &&
9593
Note: In order to use it - right click on the necessary file/folder in PhpStorm and select context menu `External Tools -> phpcs`.
9694

9795

98-
For inspecting your code you can use main menu item `Code -> Inspect Code`. Code will be processed by code quality tools like PHP CS Fixer, PHP Mess Detector, PHP CodeSniffer, PHPStan.
96+
For inspecting your code you can use main menu item `Code -> Inspect Code`. Code will be processed by code quality tools like PHP CS Fixer, PHP CodeSniffer, PHPStan, PHP Mess Detector.
9997

10098
## External documentations
10199
* [Configuring Remote PHP Interpreters](https://www.jetbrains.com/help/phpstorm/configuring-remote-interpreters.html)

docs/postman.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Postman
2-
This document describing how you can use [Postman](https://www.getpostman.com/) within this environment.
2+
This document describing how you can use [Postman](https://www.getpostman.com/).
33

44
## Using Postman
55
1. [Install Postman](https://www.getpostman.com/postman)
66
2. [Import all files from "postman" folder](postman)
77
3. Select `dev` environment in top right corner
8-
4. After getting token don't forget to update value for `token` variable in `manage environments` section in order to call protected entry points
8+
4. After getting token, don't forget to update value for `token` variable in the `manage environments` section in order to call protected entry points
99

1010
![Using Postman](images/postman_01.png)

docs/rdm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Redis GUI
2-
This document describing how you can use [RedisInsight](https://redis.com/redis-enterprise/redis-insight/) within this environment.
2+
This document describing how you can use [RedisInsight](https://redis.com/redis-enterprise/redis-insight/).
33

44
## Using RedisInsight
55
1. [Install RedisInsight](https://redis.com/redis-enterprise/redis-insight/) via your OS Application Manager or download via official web-site

docs/swagger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Swagger
2-
This document describing how you can use [Swagger](https://swagger.io/) within this environment.
2+
This document describing how you can use [Swagger](https://swagger.io/).
33

44
## Using Swagger
55
* [Local Swagger service](http://localhost/api/doc) - Open next url http://localhost/api/doc in order to use Swagger.

docs/testing.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Testing
2-
This document describing how you can run tests within this environment.
2+
This document describing how you can run tests.
33

44
### General
5-
This environment contains next [types](https://symfony.com/doc/current/testing.html#types-of-tests) of tests:
5+
This environment contains the next [types](https://symfony.com/doc/current/testing.html#types-of-tests) of tests:
66

77
* Application tests
88
* Integration tests
@@ -15,14 +15,14 @@ Note 1: Please note that this environment does not use simple phpunit as does Sy
1515
Note 2: `Application` test === `Functional` test, please use naming convention(`Application`) as described [here](https://symfony.com/doc/current/testing.html#application-tests).
1616

1717
### Commands to run tests
18-
You can run tests using following local shell command(s):
18+
You can run tests using the following local shell command(s):
1919
```bash
2020
make phpunit # Run all tests
2121
```
2222

23-
After execution above local shell command you are able to check code coverage report. Please open `reports/coverage/index.html` with your browser.
23+
After execution above local shell command, you are able to check a code coverage report. Please open `reports/coverage/index.html` with your browser.
2424

25-
If you want to run single test or all tests in specified directory you can use next steps:
25+
If you want to run a single test or all tests in specified directory, you can use the next steps:
2626

2727
1.Use next local shell command in order to enter into symfony container shell:
2828
```bash
@@ -31,23 +31,12 @@ make ssh # Enter symfony container shell
3131
2.Use next symfony container shell command(s) in order to run test(s):
3232
```bash
3333
./vendor/bin/phpunit ./tests/Application/Controller/ApiKeyControllerTest.php # Just this single test class
34-
./vendor/bin/phpunit ./tests/Application/Controller/ # All tests in this directory
34+
./vendor/bin/phpunit ./tests/Application/Controller/ # All tests in the directory
3535
```
3636

3737
### Separate environment for testing
38-
By default this environment is using separate database for testing.
38+
By default, this environment is using a separate database for testing.
3939
If you need to change separate environment for testing (f.e. change database or another stuff) you need to edit `.env.test` file.
4040

41-
42-
## Metrics
43-
This environment contains [PhpMetrics](https://github.com/phpmetrics/phpmetrics) to make some code analysis.
44-
Use next local shell command in order to run it:
45-
```bash
46-
make phpmetrics
47-
```
48-
Note: You need run tests before this local shell command.
49-
50-
After execution above local shell command please open `reports/phpmetrics/index.html` with your browser.
51-
5241
## PhpStorm
5342
You can run tests directly from your IDE PhpStorm. Please follow [PhpStorm](phpstorm.md) documentation in order to do it.

0 commit comments

Comments
 (0)