Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-11 12:28:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'develop' of https://github.com/Karaka-Management/Developer-Guide into develop

Browse Source
This commit is contained in:
Dennis Eichhorn 2024-01-12 00:38:15 +00:00
commit a75ec002ce
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
general/setup.md
View File

@ -42,11 +42,11 @@ Which IDE or editor a developer uses is up to the individual developer. From exp
## Application install options ## Application install options
Option 1 and 2 require you to install the dev tools in advance! Option 2 and 3 require you to install the dev tools in advance!
1. Option: Use the virtual machine we provide for devs which has everything setup and configured to start almost instantly after download **Most Recommended** 1. Option: Use the virtual machine we provide for devs which has everything setup and configured to start almost instantly after download **Most Recommended**
2. Option: Installs the application (with a lot of dummy data, this may take a long time). **Recommended (slow but a lot of useful data)** 2. Option: Installs the application (with a lot of dummy data, this may take a long time). **Recommended (slow but a lot of useful data)**
3. Option: Installs the application (with or without performing tests). **Recommended (slow and much less useful data)** 3. Option: Installs the application (with or without performing tests). **(slow and much less useful data)**
### Option 1: VM ### Option 1: VM
@ -88,7 +88,7 @@ This will only setup the application including some dummy data and also perform
6. Run `npm install` inside `Karaka` 6. Run `npm install` inside `Karaka`
7. Create the database `omd` in your database management software 7. Create the database `omd` in your database management software
8. Adjust the `demoSetup/config.php` file according to your settings (e.g. database user name + password) 8. Adjust the `demoSetup/config.php` file according to your settings (e.g. database user name + password)
9. Run `php demoSetup/setup.php` inside `Karaka` (takes a long time: > 1h) 9. Run `php demoSetup/setup.php` inside `Karaka` (takes a long time: > 2h)
After the installation you'll have access to the following content: After the installation you'll have access to the following content:

10
quality/inspections.md
View File

@ -234,9 +234,17 @@ npx eslint ./ -c Build/Config/.eslintrc.json
You can perform sitespeed checks by using sitespeed.io. Example: You can perform sitespeed checks by using sitespeed.io. Example:
```sh ```sh
sitespeed.io http://192.168.178.38 -b chrome --outputFolder /var/www/html/sitespeed sitespeed.io ./Build/Helper/Scripts/sitespeedDemoUrls.txt -b chrome --outputFolder /var/www/html/sitespeed
``` ```
### Profiles & trace views
1. Automatic trace and benchmark generation with every web request in `/var/www/html/webgrind/Logs`
2. Webgrind view `http://vm_ip:82`
3. Trace visualization `http://vm_ip:81`
1. Download the latest trace from `http://vm_ip:82/Logs`
2. Drag and drop that downloaded `*.xt` file in the trace visualizer
### Custom scripts ### Custom scripts
#### C++ tests #### C++ tests