An open API service indexing awesome lists of open source software.

https://github.com/druidfi/spell

Spell to summon a new Drupal project
https://github.com/druidfi/spell

composer drupal drupal-11 drupal-cms project-template stonehenge

Last synced: 11 months ago
JSON representation

Spell to summon a new Drupal project

Awesome Lists containing this project

README

          

# druidfi/spell

This is a skeleton repository which will create a new Drupal project for you and setup Docker based development
environment with Stonehenge. See requirements below.

## Includes

- Drupal 11.1.x ([Core](https://github.com/druidfi/spell/tree/core) and [CMS](https://github.com/druidfi/spell/tree/cms) variants)
- Drush 13.x
- Docker Compose setup for development
- [druidfi/tools](https://github.com/druidfi/tools)
- Web root is `./public`
- Configuration is in `./conf/cmi`
- Custom modules can be created in `./public/modules/custom`
- Recipes are in `./recipes`

## Requirements

- PHP ^8.3 and Composer
- [Docker and Stonehenge](https://github.com/druidfi/stonehenge)

## Create a new project with Composer

If you have PHP and Composer installed on your host (recommended):

### Drupal core

```console
composer -n create-project druidfi/spell:dev-core my-drupal-site
```

### Drupal CMS

```console
composer -n create-project druidfi/spell:dev-cms my-drupal-cms-site
```

## Create a new project with Docker image

If you don't have PHP and Composer, but you have Docker installed:

### Drupal core

```console
mkdir my-drupal-site && cd my-drupal-site && \
docker run --rm -it -v $PWD:/app --env COMPOSER_MEMORY_LIMIT=-1 \
druidfi/drupal-web:php-8.3 \
composer -n create-project druidfi/spell:dev-core .
```

### Drupal CMS

```console
mkdir my-drupal-cms-site && cd my-drupal-cms-site && \
docker run --rm -it -v $PWD:/app --env COMPOSER_MEMORY_LIMIT=-1 \
druidfi/drupal-web:php-8.3 \
composer -n create-project druidfi/spell:dev-cms .
```

## Get started

Now you need to have Stonehenge up & running.

Start the development environment, build development codebase and install empty site with minimal profile:

```console
make new
```

Now your site can can be accessed from https://yoursite.docker.so

## Next steps

Git has been init in the project, but you need to specify your remote before you can push.

You can run `make help` to list all available commands for you.

## Running tests on Spell when developing

On macOS you need first to install Chromedriver and allow it to execute:

```console
brew install chromedriver
xattr -d com.apple.quarantine /opt/homebrew/bin/chromedriver
```

Then run the same test scenario as in Github Actions:

```console
make test
```

## Other information

This project can be found from the Packagist: https://packagist.org/packages/druidfi/spell