brainsum/damo-project

Template for creating DAMo projects with composer.

0.8.0 2020-06-25 12:41 UTC

Requires

• php: ^7.2
• brainsum/damo-distribution: >=0.26 <1.0
• composer/installers: ^1.2
• cweagans/composer-patches: ^1.6
• drupal/core-composer-scaffold: ^8.8
• drupal/core-project-message: ^8.8
• drupal/core-recommended: ^8.8
• drush/drush: ^9.0|^10.0
• oomphinc/composer-installers-extender: ^1.1
• vlucas/phpdotenv: ^2.4

Requires (Dev)

• drupal-composer/drupal-security-advisories: 8.x-dev
• drupal/console: ^1.9
• drupal/core-dev: ^8.8
• drupal/devel: ^4.0
• drupal/devel_entity_updates: ^3.0
• drupal/devel_php: ^1.1
• roave/security-advisories: dev-master
• zaporylie/composer-drupal-optimizations: ^1.1

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

• mhavelant

README

Composer template to kickstart Digital Assets Management projects.

This template was based on the following:

• Drupal composer project
• Drupal recommended project
• Thunder distro.

Installation

Note: These commands have been tested on linux (ubuntu), they might need changes to work on other systems.

Native composer

For the latest release:

composer create-project brainsum/damo-project my-damo-project

For a specific release:

composer create-project brainsum/damo-project:0.1.0 my-damo-project

Composer in docker

For the latest release:

DAMO_PROJECT_DIR=my-damo-project; mkdir "${DAMO_PROJECT_DIR}" && docker run --rm -u "$(id -u)":"$(id -g)" -w /app --mount type=bind,src="$(pwd)"/"${DAMO_PROJECT_DIR}",dst=/app wodby/drupal-php:7.3-dev-4.14.3 composer create-project brainsum/damo-project .

For a specific release:

DAMO_PROJECT_DIR=my-damo-project; mkdir "${DAMO_PROJECT_DIR}" && docker run --rm -u "$(id -u)":"$(id -g)" -w /app --mount type=bind,src="$(pwd)"/"${DAMO_PROJECT_DIR}",dst=/app wodby/drupal-php:7.3-dev-4.14.3 composer create-project brainsum/damo-project:0.1.0 .

Note: The wodby/drupal-php image is just an example. Note: Using an image with the hirak/prestissimo composer package will speed up the process, although it also might break things (see: drupal-composer/drupal-scaffold#101).

Setup

(Optional) Docker-compose

If you want to use docker-compose for development, you should copy example.env as .env, e.g cp example.env .env. Update its contents as required.

For starting and stopping the environment you can use the helper scripts provided with the project (startup.sh and shutdown.sh). These also look for a docker-compose.local.yml file so you can version control a generic config file and do local overrides (e.g ports, mounts).

Drush

Copy drush/example.drush.yml as drush/drush.yml. Update its contents as required.

Filesystem permission fixes

E.g on linux, you must fix file and directory permissions as well, e.g for "private_files", "web/sites/default/files", "tmp", ...

Install

Use drush site-install --account-pass=somestrongpass --site-mail=[e-mail] --site-name=DAMo damo -y

You also might want to add --account-name and --account-mail.

Usage

Main site

Upload your assets and that's it. You can download them, images can be styled for social media purposes, logo can be added, etc.

API

The JSON:API module has been enabled, so you can serve your assets through that. An example would be using the FileField Sources JSON API module that allows you to configure file fields to allow downloading files from DAMo directly via the API.

Development

For development info see the DEVELOPMENT.md file.