README.md 1.46 KB
Newer Older
Felix Herrmann's avatar
Sync    
Felix Herrmann committed
1
2
# Dynamic FAQ

3
### Dependencies
4
* TYPO3 9.5.0+
Utz, Wolf-Peter's avatar
Utz, Wolf-Peter committed
5
* typoscript_rendering 2.3.0+
Felix Herrmann's avatar
Sync    
Felix Herrmann committed
6
7
8
9
10

## Overview
This extension provides a full FAQ solution with user created questions answered by admins

## Installation
11
12
13
14
15
16
 * Activate the extension via the Extensions module.
 * Include the static typo script file.
 * Navigate to the root of the extension and run:
````bash
yarn install
````
17
18

## Info
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Only questions marked as answered and published are visible in the frontend.

## How to run the tests local
To run tests, quality checks and build, execute the script `Build/Scripts/runTests.sh`.

#### The test runner script options
    -s <...>
        Specifies which test suite to run
            - build: Builds the project (composer)
            - lint: Lints the php files
            - functional: functional tests
            - unit (default): PHP unit tests
            - quality: executes code quality checks (phpstan, phpcs, phpmd)
            - find-debugs: Finds usages of debug calls.

    -p <7.2|7.3>
        Specifies the PHP minor version to be used
            - 7.2 (default): use PHP 7.2
            - 7.3: use PHP 7.3

    -e "<phpunit options>"
        Only with -s functional|unit
        Additional options to send to phpunit (unit & functional tests).
        Starting with "--" must be added after options starting with "-".
        Example -e "-v --filter canRetrieveValueWithGP" to enable verbose output AND filter tests
        named "canRetrieveValueWithGP"

    -h
        Show this help.