mirror of
https://github.com/Karaka-Management/Organization-Guide.git
synced 2026-01-28 20:08:40 +00:00
34 lines
1.0 KiB
Markdown
34 lines
1.0 KiB
Markdown
# Onboarding: Cheat-Sheet
|
|
|
|
**How to initially setup the codebase?**
|
|
|
|
* run: `git clone -b develop https://github.com/Orange-Management/Orange-Management.git`
|
|
* run: `git submodule update --init --recursive`
|
|
* run: `git submodule foreach git checkout develop`
|
|
|
|
**How to (re-)setup the demo application?**
|
|
|
|
* run: `php demoSetup/setup.php`
|
|
|
|
**Testing tools**
|
|
|
|
php: PHPUnit
|
|
|
|
* php setup run: `composer install` (requires composer to be installed)
|
|
|
|
js: Jasmine
|
|
|
|
**How to run unit tests?**
|
|
|
|
* php:
|
|
* run in main directory: `php -d pcov.enabled=1 vendor/bin/phpunit -c tests/phpunit_no_coverage.xml `
|
|
* also possible for submodules if you want to test only a specific submodule (e.g. phpOMS)
|
|
* js:
|
|
|
|
**How to run code inspection?**
|
|
|
|
* run phpstan + phpcs: `Build/Helper/testreport.sh`
|
|
* run phpstan: `php vendor/bin/phpstan analyse --autoload-file=phpOMS/Autoloader.php -l 8 -c Build/Config/phpstan.neon ./`
|
|
* run phpcs: `php vendor/bin/phpcs ./ --standard="Build/Config/phpcs.xml" -s --report-junit=Build/test/junit_phpcs.xml`
|
|
|