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

Adding installation and summary cleanup

Browse Source
This commit is contained in:
Dennis Eichhorn 2016-03-26 23:55:42 +01:00
parent 989575f217
commit 63e3bf0e27
3 changed files with 55 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
SUMMARY.md
View File

@ -1,6 +1,11 @@
# Summary
* [Introduction](README.md)
* [Installation](installation.md)
* [Documentation](documentation.md)
* [Security Guidelines](security_guidelines.md)
* [Inspections, Tests & Code Guidelines](inspections,_tests_&_code_guidelines.md)
* [Styles and Layout](styles_and_layout.md)
* [Caching, Sessions, Local Storage & Cookies](caching,_sessions,_local_storage_&_cookies.md)
* [Modules](modules.md)
* [Inspections](inspections.md)
* [Tests](tests.md)

0
inspections.md Normal file
View File

48
installation.md Normal file
View File

@ -0,0 +1,48 @@
# Installation
Installing the application as a developer can be achived by following one of the following instructions
## Linux Shell Script
This is the prefered way to install the application since this also installs all required dev tools and sets up the direcetory structure by itself. Using this method also tears down previous installs for a fresh install perfect for re-installing from the current development version. Furthermore the use of phpUnit also makes sure that the application is working as intended. The phpUnit install also provides lots of dummy data for better integration and functionality testing of your own code/modules.
### Requirements
1. PHP 7.0
2. npm
3. xdebug or phpdbg
### Steps
1. Go somewhere where you want to install the build script
2. Enter `git clone -b develop https://github.com/Orange-Management/Build.git`
3. Modify `var.sh`
4. Run `chmod 777 setup.sh`
5. Run `./setup.sh`
6. Modify `config.php`
7. Run `php phpunit.phar --configuration Tests/PHPUnit/phpunit_default.xml` inside `Orange-Management` or open `http://your_url.com/Install`
### Annotation
The database user and password can't be changed right now since the install config relies on the same data. Future releases will make use of a new user that will get set up by the install script as well. If you don't have `xdebug` installed but `phpdbg` you can replace `php phpunit.phar ...` with `phpdbg -qrr phpunit.phar ...`.
## FTP Web Install
This only installs an application without any dev tools that may be required by other scripts in order to test your implementations.
### Requirements
1. PHP 7.0
2. xdebug or phpdbg
3. phpunit
### Steps
1. Download all Orange-Management repositories
2. Put all repositories inside the Orange-Management repository
3. Modify `config.php`
4. Run `php phpunit.phar --configuration Tests/PHPUnit/phpunit_default.xml` inside `Orange-Management` or open `http://your_url.com/Install`
### Annotation
Re-installing the application this way requires you to drop and re-create the database.