swipswaps/website

Student Windsurfing Association website

SWA

This repository contains a Joomla component that contains most of the logic for the Student Windsurfing Association website.

And a Joomla Plugin adding some custom behavior for view levels based on data provided by the SWA component. The plugin uses onJAccessGetAuthorisedViewLevels, a custom event that needs to be added to Joomla code.

Production (live site)

• Create zip files for the component and plugin using composer build.
• Go to the Joomla backend, http://localhost:5555/administrator
• Log in (admin:password)
• Top menu, Extensions >> Manage >> Install
• Select "Upload package from file"
• Upload the com_swa.zip file that was created in the root repo folder
• Upload the plg_swa_viewlevels.zip file that was created in the root repo folder
• Enable the plugin in the Extensions >> Plugins page
• Add the custom event to Joomla code (see below)

Adding onJAccessGetAuthorisedViewLevels custom event

For the plugin to work a custom event must be added to the JAccess::getAuthorisedViewLevels method which can be found in libraries\src\Access\Access.php.

Add the following code just before the final return of the method:

// START HACK for plg_swa_viewlevels
require __DIR__ . '/../../../plugins/swa/viewlevels/eventsnippet.php';
// END HACK for plg_swa_viewlevels

Template notes

The original template sources is https://www.favthemes.com/joomla-templates/product/favourite-free-responsive-joomla-3-template A copy of this can be found on the SWA Drive "Tech/Web Dev/Templates/favourite_j!3_UnzipFirst.zip"

Development - Dependencies

docker & docker-compose

To make your life easy you can run many things related to development in docker.

To do so you would need to install the following:

• Docker
• docker-compose

Note: It is possible to develop without docker.

composer

In order to install the needed packages for development you'll need composer. Composer is a dependency manager and command runner for PHP.

Use it to install the PHP libraries needed for testing, development and production.

The easiest way to use composer to install the required libs is via the official docker image.

For linux and bashy systems that would be:

docker run --rm -it -v $PWD:/app composer <command here>

If you are on windows using CMD that would be:

docker run --rm -it -v %CD%:/app composer <command here>

Install composer dependencies

composer install

Development - Environment

The recommended dev environment uses docker-compose.

The general cheat sheet is below, but you'll need to do some other things for your first setup...

• docker-compose up (-d to do detached)
• docker-compose ps (to check it is there and running)
• docker-compose down (--volume to also remove SQL data in docker volume)

The default things will be here (unless you changed them in your .env file)

• Joomla front: http://localhost:5555
• Joomla back: http://localhost:5555/administrator (user: admin, password: password)
• Adminer: http://localhost:5556 (user: root, password: example)

Joomla is populated with a sample SWA data set, this is done in ./.docker/db/initdb/init.sql. This data set includes some example users, all of their passwords are password

• admin - Super User
• johnsmith
• janesmith
• mthomp
• bendover
• swacom
• unicom

Launch services

docker-compose up -d

Other Plugins

You will need to install these plugins to reach parity with the live site

• Folcomedia - Cookies Alert

Development - Tests

Many tests are runable via composer commands. Have a look in composer.json to see what commands are available, or run composer list.

All of these tests are also run in Github Actions for Pull Requests.

• minus-x - Removes executable flags from files that should not have them.
  • minus-x:check - Checks files listing issues.
  • minus-x:fix - Checks files fixing issues.
• lint - Runs a linter against PHP files.
• phpcs - Runs the PHP Codesniffer, with a modified Joomla ruleset (see .phpcs.xml).
• phpcbf - Runs the PHP Code Beautifier and Fixer, which is part of PHP Codesniffer.
• phpunit - A testing framework for PHP.
  • phpunit:unit - Runs "unit" tests only, as defined in the tests/unit directory.
  • phpunit:browser - Runs "unit" tests only, as defined in the tests/browser directory. (requires additional setup, see below)
    • You can run individual tests using commands like composer phpunit:browser -- --filter HomeTest

These individual commands are combined in a few usefull meta commands.

To run all fixers just run:

composer fix

To run all all basic linters and tests (excludes browser tests) run:

composer ci

Browser tests

The Browser tests can be run entirely in docker against the development environment Joomla install.

In order to start the extra containers needed run:

docker-compose -f docker-compose-selenium.yml up

You should then be able to run the tests using:

composer phpunit:browser

The browser test setup includes a container that will record a video while the containers are running. You will NOT be able to view this video until the containers are stopped (and the video file is no longer being written to).

WARNING: leaving this container running for a long time will slowly eat up your disk space.

To stop the browser test related containers run:

docker-compose -f docker-compose-selenium.yml down

You should then be able to see a video of the browser in .docker/selenium/videos.

Github Actions

Github Actions is used for continuous integration for this repository.

The configuration for the actions can be found in .github/workflows.

The CI currently runs on all PRs and merges into the master branch.