Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-02-09 08:58:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-04-21 23:52:00 +02:00
parent 308c6cf976
commit 90d0add1f1
5 changed files with 25 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
general/first_steps.md
View File

@ -4,10 +4,10 @@ After you installed the application and configured your development environment
Please note that besides the general development guide the organization also provides various other organizational documents which help to understand the processes, development status and decisions made. Please note that besides the general development guide the organization also provides various other organizational documents which help to understand the processes, development status and decisions made.
* [Development process](https://github.com/Karaka-Management/Docs/blob/master/Processes/Development.md) * [Development process](https://github.com/Karaka-Management/Organization-Guide/blob/master/Processes/Development.md)
* [Code inspection]({%}?page=quality/inspections) * [Code inspection]({%}?page=quality/inspections)
* [Project status](https://github.com/Karaka-Management/Docs/blob/master/Project/PROJECT.md) * [Project status](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md)
* [Code of conduct](https://github.com/Karaka-Management/Docs/blob/master/Policies%20%26%20Guidelines/Code%20of%20conduct.md) * [Code of conduct](https://github.com/Karaka-Management/Organization-Guide/blob/master/Policies%20%26%20Guidelines/Code%20of%20conduct.md)
* [Conflict of interest](https://github.com/Karaka-Management/Docs/blob/master/Policies%20%26%20Guidelines/Conflict%20of%20Interest%20Policy.md) * [Conflict of interest](https://github.com/Karaka-Management/Organization-Guide/blob/master/Policies%20%26%20Guidelines/Conflict%20of%20Interest%20Policy.md)
* [Activity Policy](https://github.com/Karaka-Management/Docs/blob/master/Policies%20%26%20Guidelines/Organization%20Activity%20Policy.md) * [Activity Policy](https://github.com/Karaka-Management/Organization-Guide/blob/master/Policies%20%26%20Guidelines/Organization%20Activity%20Policy.md)
* [Organization Guidelines](https://github.com/Karaka-Management/Docs/blob/master/Policies%20%26%20Guidelines/Organization%20Guidelines.md) * [Organization Guidelines](https://github.com/Karaka-Management/Organization-Guide/blob/master/Policies%20%26%20Guidelines/Organization%20Guidelines.md)

34
general/setup.md
View File

@ -4,7 +4,7 @@ In order to setup the application for development for the first time please see
## Dev-Environment Requirements ## Dev-Environment Requirements
Follow the general install/setup documentation until the application setup: [Install](https://github.com/Karaka-Management/Documentation/blob/develop/setup/install.md) Follow the general install/setup documentation until the application setup: [Install](https://github.com/Karaka-Management/User-Guide/blob/develop/setup/install.md)
The following dev tools are highly recommended and the documentation assumes you installed them and added them to your environment paths on Windows. On linux they should be accessible immediately after installation. The following dev tools are highly recommended and the documentation assumes you installed them and added them to your environment paths on Windows. On linux they should be accessible immediately after installation.
@ -33,15 +33,14 @@ Option 1 and 2 require you to install the dev tools in advance!
This will only setup the application including some dummy data and also perform the code tests but no quality checks. Compared to option 2 this includes much more test data and it doesn't execute a unit test. This will only setup the application including some dummy data and also perform the code tests but no quality checks. Compared to option 2 this includes much more test data and it doesn't execute a unit test.
1. Go to the directory where you want to install the application 1. Go to the directory where you want to install the application
2. Run `git clone -b develop https://github.com/karaka-management/Karaka.git` 2. Run `git clone -b develop --recurse-submodules -j8 https://github.com/Karaka-Management/Karaka.git`
3. Run `git submodule update --init --recursive` 3. Run `git submodule foreach git checkout develop`
4. Run `git submodule foreach git checkout develop` 4. Run `git clone -b master https://github.com/Karaka-Management/demoSetup.git`
5. Run `git clone -b master https://github.com/Karaka-Management/demoSetup.git` 5. Run `composer install` inside `Karaka`
6. Run `composer install` inside `Karaka` 6. Run `npm install` inside `Karaka`
7. Run `npm install` inside `Karaka` 7. Create the database `oms` in your database management software
8. Create the database `oms` in your database management software 8. Adjust the `demoSetup/config.php` file according to your settings (e.g. database user name + password)
9. 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)
10. Run `php demoSetup/setup.php` inside `Karaka` (takes a long time: > 1h)
After the installation you'll have access to the following content: After the installation you'll have access to the following content:
@ -75,14 +74,13 @@ This will only setup the application including some dummy data and also perform
#### Steps #### Steps
1. Go to the directory where you want to install the application 1. Go to the directory where you want to install the application
2. Run `git clone -b develop https://github.com/karaka-management/Karaka.git` 2. Run `git clone -b develop --recurse-submodules -j8 https://github.com/Karaka-Management/Karaka.git`
3. Run `git submodule update --init --recursive` 3. Run `git submodule foreach git checkout develop`
4. Run `git submodule foreach git checkout develop` 4. Run `composer install` inside `Karaka`
5. Run `composer install` inside `Karaka` 5. Run `npm install` inside `Karaka`
6. Run `npm install` inside `Karaka` 6. Create the database `oms` in your database management software
7. Create the database `oms` in your database management software 7. Adjust the `tests/Bootstrap.php` file according to your settings (e.g. database user name + password)
8. Adjust the `tests/Bootstrap.php` file according to your settings (e.g. database user name + password) 8. Run `php vendor/bin/phpunit --configuration tests/phpunit_no_coverage.xml` inside `Karaka` or open `http://127.0.0.1/Install`
9. Run `php vendor/bin/phpunit --configuration tests/phpunit_no_coverage.xml` inside `Karaka` or open `http://127.0.0.1/Install`
After the installation you'll have access to the following content: After the installation you'll have access to the following content:

2
quality/inspections.md
View File

@ -288,4 +288,4 @@ find ./Web ./phpOMS ./jsOMS ./cOMS ./Model ./Build ./Modules \( -name "*.php" -o
## References ## References
[Development process](https://github.com/Karaka-Management/Docs/blob/master/Processes/Development.md) [Development process](https://github.com/Karaka-Management/Organization-Guide/blob/master/Processes/Development.md)

2
standards/documentation.md
View File

@ -175,7 +175,7 @@ In some cases it may be required to type hint a variable in this case the follow
## Todos ## Todos
Todos should be documented in the [PROJECT.md](https://github.com/karaka-management/Docs/blob/master/Project/PROJECT.md). Todos should be documented in the [PROJECT.md](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md).
In code todos can be created like this In code todos can be created like this

2
standards/php.md
View File

@ -1,6 +1,6 @@
# Php # Php
The php code needs to be php 8.0 compliant. No php 8.0 deprecated or removed elements, functions or practices are allowed (e.g. short open tag). Please use the `phpcs.xml` configuration for PHP Code Sniffer to identify most of the basic code standards. The php code needs to be php 8.1 compliant. No php 8.1 deprecated or removed elements, functions or practices are allowed (e.g. short open tag). Please use the `phpcs.xml` configuration for PHP Code Sniffer to identify most of the basic code standards.
## Php Tags ## Php Tags