THE Port Website

This repository contains the code to run the website of THE Port Association hosted at theport.ch.

Project

All the latest development tasks are listed on the Project Board.

The tech stack is Linux, Apache 2, MySQL 5 and PHP 8. In addition, the website is built with:

The content management system Drupal 9
The content editor Gutenberg
The front-end toolkit Bootstrap 5

Local Development

Three steps are necessary to run the website locally:

Install the virtualization software
Run the recipe included in this repo to automatically install the environnement and dependencies
Go through the installation process of the website's content management system

There are two additional steps that are optional:

Import the website configuration, or
Import the website content

The configuration of this website is included in the repository (in the config directory). Alternatively, the website content can be provided by a contributor. Note that importing the content also includes all the necessary configuration, so only this one step would be necessary.

Installation

The project uses Lando to configure and run the development environment. Upon installing Lando, execute the following from the project's root directory:

  lando start

The initial setup will take a few minutes as all the required software is downloaded. A message will be shown in the terminal once completed. Visit theport.lndo.site in your browser and you should see the Drupal installation screen. Go through the steps to reach the database configuration. The database name, and password are drupal9. In the advanced database settings change the connection from localhost to database (this is the host name configured in Lando). Upon completing the Drupal installation, you will reach a basic version of the website without any content.

Import Content

To import content, a recent GDPR-compliant database dump can be provided to you by one of the other repository contributors. To import the database, execute the following command in the project's root directory:

  lando db-import dump.sql.gz

Upon importing the database, you will want to clear the website cache by running the command lando drush cache-rebuild. Refresh theport.lndo.site in your browser and you will then see the website content.

Import Configuration

To synchronize configuration between environments (without any content), use the following commands:

  lando drush config-import --source=../config

Development Tools

The database administration software PHPMyAdmin and the email utility Mailhog are also included in the environment (see the Lando configuration file). These can be accessed at db.theport.lndo.site and mail.theport.lndo.site.

The project uses Composer to manage all dependencies and Drush to run tasks from the command line. These can be called via Lando, for example:

  lando composer install
  lando drush cache-rebuild

Some local development settings are included in this repository, but they do not get loaded by default. Simply add the following to the end of your settings.php located in the folder web/sites/default.

/**
 * Local development settings.
 */
include $app_root . '/sites/settings.local.php';

Custom Configuration, Theme, and Modules

The majority of tasks are accomplished using the Drupal administration interface. For example, a new Drupal View should be created and configured there. Upon making a change in the administration interface, export the configuration as follows:

lando drush config-export --destination=../config

The generated configuration files can be checked into this repository.

There is a custom theme named "theport" that allows a detailed designs of the site. Please refer to the Readme in the theme's folder.

In addition there are custom modules such as the "Projects Page". Please refer to the Readme in the Projects Page folder.

THEPortatCERN/THE-Port-Website