-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FEATURE] Add a development part to documentation
- Loading branch information
1 parent
4f13a88
commit af89b6d
Showing
2 changed files
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") | ||
![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") | ||
|
||
## How to develop with LUX | ||
|
||
### LUX | ||
|
||
#### Local test environment | ||
|
||
LUX ships its own testing environment based on docker. This can simply be started in the same folder as LUX with | ||
`make install-project` for the first time and then | ||
`make stop` to stop the container and | ||
`make start` to start it again | ||
|
||
After that Backend is reachable under https://local.lux.de/typo3/ | ||
|
||
Login is possible with `akellner` as username and password. | ||
|
||
*Note* Doing a `make` on CLI lists a bunch of useful commands (like clear caches, etc...) | ||
*Note* Docker and Dinghy should be installed on your unix system first | ||
|
||
#### Run tests | ||
|
||
There are different tests that can be started locally. First of all, you have to login into the PHP-container with | ||
`make login-php` | ||
|
||
After that, you can run different tests: | ||
|
||
| Test | Command | | ||
|-------------------------|--------------------------| | ||
| Start code sniffer test | `composer test:php:cs` | | ||
| Start PHP linter | `composer test:php:lint` | | ||
| Start TypoScript linter | `composer test:ts:lint` | | ||
| Start unit tests | `composer test:unit` | | ||
|
||
### LUXenterprise | ||
|
||
If you clone LUXenterprise, you have basically the same possibilities as in LUX, but LUXenterprise will also install LUX | ||
of course. | ||
|
||
#### Local test environment | ||
|
||
LUX ships its own testing environment based on docker. This can simply be started in the same folder as LUX with | ||
`make install-project` for the first time and then | ||
`make stop` to stop the container and | ||
`make start` to start it again | ||
|
||
After that Backend is reachable under https://local.luxenterprise.de/typo3/ | ||
|
||
Login is possible with `akellner` as username and password. | ||
|
||
*Note* Doing a `make` on CLI lists a bunch of useful commands (like clear caches, etc...) | ||
*Note* Docker and Dinghy should be installed on your unix system first | ||
|
||
#### Run tests | ||
|
||
There are different tests that can be started locally. First of all, you have to login into the PHP-container with | ||
`make login-php` | ||
|
||
After that, you can run different tests: | ||
|
||
| Test | Command | | ||
|-------------------------|--------------------------| | ||
| Start code sniffer test | `composer test:php:cs` | | ||
| Start PHP linter | `composer test:php:lint` | | ||
| Start TypoScript linter | `composer test:ts:lint` | | ||
| Start unit tests | `composer test:unit` | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters