fix name
0
SUMMARY.md
Normal file → Executable file
0
basics/dispatching.md
Normal file → Executable file
4
basics/language_files.md
Normal file → Executable file
|
|
@ -13,14 +13,14 @@ The content of the language files is very simple. All you need is the module nam
|
|||
```php
|
||||
<?php
|
||||
/**
|
||||
* Orange Management
|
||||
* Karaka
|
||||
*
|
||||
* PHP Version 8.0
|
||||
*
|
||||
* @copyright Dennis Eichhorn
|
||||
* @license OMS License 1.0
|
||||
* @version 1.0.0
|
||||
* @link https://orange-management.org
|
||||
* @link https://karaka.app
|
||||
*/
|
||||
declare(strict_types=1);
|
||||
|
||||
|
|
|
|||
0
basics/requests.md
Normal file → Executable file
0
basics/responses.md
Normal file → Executable file
0
basics/routing.md
Normal file → Executable file
0
basics/views.md
Normal file → Executable file
0
cover.jpg
Normal file → Executable file
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 226 KiB |
0
datastorage/cache.md
Normal file → Executable file
0
datastorage/cookie.md
Normal file → Executable file
0
datastorage/database/connection.md
Normal file → Executable file
0
datastorage/database/datamapper.md
Normal file → Executable file
0
datastorage/database/queries.md
Normal file → Executable file
0
datastorage/localstorage.md
Normal file → Executable file
0
datastorage/session.md
Normal file → Executable file
0
example_app/app.md
Normal file → Executable file
4
example_module/module.md
Normal file → Executable file
|
|
@ -334,11 +334,11 @@ The `info.json` file contains general module information used during installatio
|
|||
|
||||
### Name
|
||||
|
||||
The name category contains the names used for internal as well as external identification. Both `id` and `internal` are globally unique between all modules and is assigned generated by Orange Management. The `id` can also be used by other modules which need integer identification of modules. The `id` has the form `xxxxx00000` which means, that modules don't only occupy a single id but a range of ids. This can be useful for other modules where additional module specific information need to be assigned (e.g. `Navigation` module). The `external` name is the name the creator of the module can give the module. This is the name that will be used during searches for modules and shown to customers.
|
||||
The name category contains the names used for internal as well as external identification. Both `id` and `internal` are globally unique between all modules and is assigned generated by Karaka. The `id` can also be used by other modules which need integer identification of modules. The `id` has the form `xxxxx00000` which means, that modules don't only occupy a single id but a range of ids. This can be useful for other modules where additional module specific information need to be assigned (e.g. `Navigation` module). The `external` name is the name the creator of the module can give the module. This is the name that will be used during searches for modules and shown to customers.
|
||||
|
||||
### Version
|
||||
|
||||
The version is automatically incremented by Orange Management. The version might be used by other modules in order to require a specific version of a module. Versions must follow the following format:
|
||||
The version is automatically incremented by Karaka. The version might be used by other modules in order to require a specific version of a module. Versions must follow the following format:
|
||||
|
||||
```js
|
||||
major.minor.build = 2.512.19857
|
||||
|
|
|
|||
0
example_module/packages.md
Normal file → Executable file
0
example_module/update.md
Normal file → Executable file
0
frontend/notifications.md
Normal file → Executable file
0
general/app_flow.drawio.svg
Normal file → Executable file
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
0
general/base_uml.drawio.svg
Normal file → Executable file
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
6
general/setup.md
Normal file → Executable file
|
|
@ -33,7 +33,7 @@ This also installs all required dev tools and sets up the directory structure by
|
|||
The following steps will setup the application, download all necessary tools and perform extensive code quality checks and documentation tasks:
|
||||
|
||||
1. Go to the directory where you want to install the build script
|
||||
2. Run `git clone -b develop https://github.com/Orange-Management/Build.git`
|
||||
2. Run `git clone -b develop https://github.comkaraka-management/Build.git`
|
||||
3. Modify `config.sh` (most likely the db credentials and paths)
|
||||
4. Run `chmod +x buildProject.sh`
|
||||
5. Run `./buildProject.sh`
|
||||
|
|
@ -58,7 +58,7 @@ This will only setup the application including some dummy data and also perform
|
|||
### Steps
|
||||
|
||||
1. Go to the directory where you want to install the application
|
||||
2. Run `git clone -b develop https://github.com/Orange-Management/Orange-Management.git`
|
||||
2. Run `git clone -b develop https://github.comkaraka-management/Orange-Management.git`
|
||||
3. Run `git submodule update --init --recursive`
|
||||
4. Run `git submodule foreach git checkout develop`
|
||||
5. Install Composer
|
||||
|
|
@ -101,7 +101,7 @@ The following tools are important to test the application and to ensure the code
|
|||
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
|
||||
2. Run `git clone -b develop https://github.com/Orange-Management/Orange-Management.git`
|
||||
2. Run `git clone -b develop https://github.comkaraka-management/Orange-Management.git`
|
||||
3. Run `git submodule update --init --recursive`
|
||||
4. Run `git submodule foreach git checkout develop`
|
||||
5. Install Composer
|
||||
|
|
|
|||
0
general/structure.md
Normal file → Executable file
0
logo.png
Normal file → Executable file
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
0
math/matrix.md
Normal file → Executable file
0
quality/inspections.md
Normal file → Executable file
0
security/security_guidelines.md
Normal file → Executable file
0
services/authentication.md
Normal file → Executable file
0
services/charting.md
Normal file → Executable file
0
services/codes.md
Normal file → Executable file
0
services/codes1.png
Normal file → Executable file
|
Before Width: | Height: | Size: 136 B After Width: | Height: | Size: 136 B |
0
services/events.md
Normal file → Executable file
0
services/filesystem.md
Normal file → Executable file
0
services/localization.md
Normal file → Executable file
0
services/logging.md
Normal file → Executable file
0
services/mail.md
Normal file → Executable file
0
services/money.md
Normal file → Executable file
0
services/parsers.md
Normal file → Executable file
0
services/queues.md
Normal file → Executable file
0
services/rng.md
Normal file → Executable file
0
services/tasks.md
Normal file → Executable file
0
services/uri.md
Normal file → Executable file
0
services/validation.md
Normal file → Executable file
0
standards/definitions.md
Normal file → Executable file
6
standards/documentation.md
Normal file → Executable file
|
|
@ -45,7 +45,7 @@ A file documentation MUST be implemented in the following form:
|
|||
* PHP Version 7.0
|
||||
*
|
||||
* @package Package name
|
||||
* @copyright Orange Management
|
||||
* @copyright Karaka
|
||||
* @license OMS License 1.0
|
||||
* @version 1.0.0
|
||||
* @link http://your.url.com
|
||||
|
|
@ -120,7 +120,7 @@ The javascript documentation is based on JsDoc, therefore only valid JsDoc comme
|
|||
* File description.
|
||||
*
|
||||
* @package Package name
|
||||
* @copyright Orange Management
|
||||
* @copyright Karaka
|
||||
* @license OMS License 1.0
|
||||
* @version 1.0.0
|
||||
* @link http://your.url.com
|
||||
|
|
@ -175,7 +175,7 @@ In some cases it may be required to type hint a variable in this case the follow
|
|||
|
||||
## Todos
|
||||
|
||||
Todos should be documented in the [PROJECT.md](https://github.com/Orange-Management/Docs/blob/master/Project/PROJECT.md).
|
||||
Todos should be documented in the [PROJECT.md](https://github.comkaraka-management/Docs/blob/master/Project/PROJECT.md).
|
||||
|
||||
In code todos can be created like this
|
||||
|
||||
|
|
|
|||