Skip to content

Commit

Permalink
[FEATURE] Add a development part to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
einpraegsam committed Oct 28, 2024
1 parent 4f13a88 commit af89b6d
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
67 changes: 67 additions & 0 deletions Documentation/Developer/Index.md
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` |
3 changes: 3 additions & 0 deletions Documentation/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ We want to give you hints from time to time to get best results with your market

## [Technical documentation](Technical/Index.md)
A fully technical documentation how to install, configure and extend lux to your needs.

## [Developer documentation](Developer/Index.md)
How to develop with LUX and LUXenterprise

0 comments on commit af89b6d

Please sign in to comment.