APM

This is the web app running at http://averroes.uni-koeln.de/apm

It requires

• PHP 8.1 with the following extensions enabled: xml, gd, mbstring, mysql, intl and zip
• a running MySQL Server 5.7+ configured with a database and a user with access to that database.
• Open JDK 8 (which is required by Collatex) (Note: Open JDK11 should not be used; it emits a deprecation warning that breaks Collatex normal output)
• NodeJS 16
• Python3

It has been developed and tested in an Ubuntu 22.04 server with standard packages.

Development

Besides the general requirements given above, development requires:

• git 2.7.4+
• an empty test database and a test user with access to it in MySQL
• PHP xdebug extension (for code coverage)
• PHP Composer 1.6.5+
• jasmine 3.2.1+ (included in source code)

Clone the repository from Github.

Get all PHP dependencies with composer:

cd src/www
composer update

Get all Javascript dependencies for the web app and nodeJS with npm:

cd src/www
npm install
cd ../node
npm install

Create a testconfig.php file under src/www/test/php/SiteMockup with the correct test database credentials.

Perform all PHP tests:

cd src/www/test/php
./phpunit .

If the installation is correct, all tests should pass in the master branch. If not, create an issue in Github to discuss possible solutions. Don't just fix the issues and push your master branch to Github as this may break other people's environments.

To run the app in development:

• Create a configuration file in src/www (see src/www/config.sample.php). Notice especially the location of the log file and the temporary directory for Collatex, these may have to be created. For development purposes, you can use log/apm.log for the main log file and collatex/tmp for the collatex temporary directory as these are marked as ignored in .gitignore. You need to create them manually.
• Create the database structure with the SQL script /src/db/dbcreation.sql.
• Run the PHP7.2 webserver with root in src Run:

  ./runphpwebserver

• Create at least one user in the system with root status using the command line:

  cd src/www/utilities;
  ./createuser <someuser>
  ./makeroot <someuser>

• Browse to http://localhost:8888, the APM should be functional.
• Perform all JS web tests by browsing to http://localhost:8888/test/js/runtests.html, these test should all pass in the master branch

Once you are sure that the development environment is working, checkout or create a new branch for your changes. Don't work on the master branch.

Installation in production

To install in production:

• Create a distribution tar file with createdist.bash
• Copy the tar file to the server and unpack it in the desired folder
• Copy config.sample.php to config.php and edit it with the appropriate parameters
• Create the database structure in the server using the scripts in db
• Configure the web server so that all request are handled by index.php In an Apache server this can be done with the rewrite rules given in url-rewrite-rules. Copy them to the directory configuration in the apache configuration or to an .htaccess file
• Create at least one user in the system with root status using the command line utilities as indicated above.