americanart/guidepost

This package is abandoned and no longer maintained. No replacement package was suggested.

A Drupal distribution for authoring and delivering tour.json

dev-8.x-1.x 2019-11-12 20:00 UTC

Requires

• php: ^7.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• composer/installers: ^1.6
• cweagans/composer-patches: ^1.6.5
• drupal-composer/drupal-scaffold: ^2.6
• drupal/admin_toolbar: ^2.0
• drupal/config_filter: ^1.5
• drupal/config_sync: ^2.0
• drupal/console: ^1.9
• drupal/core: ^8.7
• drupal/entity_browser: ^2.2
• drupal/entity_reference_revisions: ^1.7
• drupal/field_group: ^3.0
• drupal/geofield: ^1.6
• drupal/leaflet: ^1.21
• drupal/leaflet_widget: ^2.0
• drupal/paragraphs: ^1.10
• drush/drush: ^9.7
• vlucas/phpdotenv: ^3.3
• webflo/drupal-finder: ^1.1
• webmozart/path-util: ^2.3
• zaporylie/composer-drupal-optimizations: ^1.1

Requires (Dev)

• drupal/devel: ^2.1
• webflo/drupal-core-require-dev: ^8.7

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

• Eric Pugh
• Rich Brassell

README

Read the documentation

Installation

Requirements

Assuming an environment meeting Drupal 8's system requirements:

• PHP 7.1 or higher
• MySQL 5.5.3/MariaDB 5.5.20 or higher
• Apache/Nginx

Requires Composer and Git

Install

1. Create the project:

   composer create-project americanart/guidepost:dev-8.x-1.x guidepost --no-interaction
   

2. Create or edit the .env file in the project directory with your database credentials. (see the .env.example file):

   cd guidepost
   cp .env.example .env
   

3. Install the site from configuration using Drush:

   cd web
   ../vendor/bin/drush site:install --existing-config --account-name=admin --account-pass=admin
   

Updating

Guidepost uses the Configuration Synchronizer module to help updating existing installations and merge configuration changes when customizations have been made to the Distribution.

1. Update the project

   composer update americanart/guidepost
   

2. Merge potential configuration changes from the distribution into your project:

   cd web
   ../vendor/bin/drush config-distro-update
   

Local development

While not a requirement, project maintainers recommend Lando for a simple local development environment. To get started, install Docker and Lando locally.

1. Create the project:

   composer create-project americanart/guidepost:dev-8.x-1.x guidepost --no-interaction
   

2. Create or edit the .env file in the project directory with your database credentials. (the .env.example file uses the Lando defaults):

   cd guidepost
   cp .env.example .env
   

3. Start Lando from the project root. This creates all the necessary Docker containers as "services".

   lando start
   

4. Install Drupal from Guidepost's existing configuration

   lando drush site:install --existing-config --account-name=admin --account-pass=admin