steve-martin-at-esure / digital_app_template-drupal-temp

DIGITAL APP TEMPLATE - DRUPAL

This Digital App is a 'template' for developing other Drupal 8 Digital Apps. The contents of this MD file (and the others found within this repository) outline some of the key elements you should be looking to include when documenting your new Digital App.

Please esure you fork off this GIT repository before you start developing your new Digital App.

Prerequisites

• Linux (or Mac for development)
• Docker
• Docker Compose
• A local installation of composer
• (Development Only) NPM and Grunt

Installing

Please download the GIT repository to a wokring folder and ensure docker is running before running these scripts.

For Mac:
Download, Install and run Docker for Mac.
URL: https://docs.docker.com/engine/installation/mac/#/docker-for-mac

For Unix:
sudo curl -fsSL https://get.docker.com/ | sh
sudo yum install python-pip
sudo pip install backports.ssl_match_hostname --upgrade
sudo pip install docker-compose

sudo systemctl enable docker.service
sudo systemctl start docker

(use `sudo systemctl stop docker` to stop docker after you have finsihed)

(From the Digital App's 'root' directory)

Development
./scripts/install/install_local_dev1.sh

Test or Production
./scripts/install/install.sh

Once the Digital App has been installed it's recommended that you create a new Admin user and password,
using the following script:

./scripts/drupal_admin/set_admin_password.sh

Usage

Once the Digital App has been installed it can be accessed via the web browser:

For Development
http://localhost:8081/

For Test or Production
http://[NAME_OF_HOST_SERVER]/

Overview

This Digital App consists of the following components:

• app: This folder contains the Digital App's source code. Files within this folder structure are 'compiled' and placed within the 'web' folder - where the Drupal site is located. More detail the architecture and components on this Digital App's can be found here.

• container: This folder contains all of the Docker 'container' configuration files used by Docker; e.g. PHP config, etc. This is executed by the Dockerfile when the container is built or updated. Further details on the docker container can be found here.

• scripts: This folder contains a number of scripts required to run, deploy and develop this Digital App. Further details on the scripts available can be found here

• testing: This folder contains details on how to testing this Digital App. Further details on the tests available can be found here.

• web: (Created on Install) Once the Digital App is installed this folder will contain the 'working' version of the site. This is the folder used by Drupal 8.

• vendor: (Created on Install) This folder contains the packages installed by Composer.

• node_modules: (Created on Install) This folder contains the packages installed by NPM.

Contributing to this Digital App

Only esure's Digital Apps team is permitted to update this Digital App. If you have any suggestions or if you find an issue then please contact the team. Please see AUTHORS.md for details of the team.

For details on contributing best practices please see the CONTRIBUTING.md file.

Systems Documentation

All systems documentation for this Digital App is located on Confluence.