VadaProject / application

Warning: This README.md document is a work in progress, and is currently only ready for internal usage.

This repository holds the PHP files which make up the application's front-end.

Deploying for local development

Initialize Apache web server

1. Download and install XAMPP and Composer.
2. Clone this repository into XAMPP's htdocs/ folder and name the folder directory.

   • cd [xampp_root]/htdocs
     git clone https://github.com/VadaProject/application.git directory

3. From XAMPP's control panel, start the Apache and MySQL servers.

Initialize database

1. Log into the phpMyAdmin dashboard at https://localhost/phpmyadmin/
2. From the SQL tab, load and execute the script vadaProject.sql.
   • This should create a vadaProject database and its tables.
3. Optional step: load and execute the script create_dummy_claims.sql.
4. Create a new account with the username vadaUser, and a secure password.
   • Change the user's hostname from '%' to localhost.

Configure database authentication

1. Create the file config/.env.php with the following text:

   $DB_SERVER = 'localhost';
   $DB_USERNAME = 'vadaUser';
   $DB_PASSWORD = '== MY PASSWORD ==';
   $DB_DATABASE = 'vadaProject';

2. A local instance of the Vada Project should now be functional at https://localhost/directory.

Deploying

T.B.D

Tooling and development

To ensure consistency, please use Visual Studio Code alongside the following linting utilities.

1. Install Composer and PHP
   • macOS: available on Homebrew (brew install php composer)
   • Windows and Linux install guide
2. Install Composer dependencies:

   • composer install

   • Binaries for GrumPHP, PHP-CS-Fixer, and PHP_CodeSniffer will be installed in ./vendor/bin/
3. Install the suggested extensions in VS Code.
   • A popup should appear upon opening the project for the first time.
   • Warnings from PHP_Codesniffer should now appear in the "Problems" tab
4. Before comitting, activate GrumPHP to show errors:

   • ./vendor/bin/grumphp run