Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jackd248/ddev-commands-collection
Collection of reusable DDEV commands
https://github.com/jackd248/ddev-commands-collection
command composer ddev drupal symfony typo3
Last synced: 3 months ago
JSON representation
Collection of reusable DDEV commands
- Host: GitHub
- URL: https://github.com/jackd248/ddev-commands-collection
- Owner: jackd248
- License: mit
- Created: 2022-02-14T06:59:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T14:09:48.000Z (6 months ago)
- Last Synced: 2024-10-14T06:12:42.783Z (3 months ago)
- Topics: command, composer, ddev, drupal, symfony, typo3
- Language: Shell
- Homepage:
- Size: 86.9 KB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DDEV Commands Collection
========================
The __DCC__ (DDEV Commands Collection) provides several predefined [DDEV](https://ddev.readthedocs.io/en/stable/) commands for different project types.
- [Intention](#intention)
- [Installation](#installation)
- [Impact](#impact)
The project comes with an automatic copy and update process of the commands as well as several customization options. So the DDEV commands in your local project under `.ddev/commands` will always keep updated extended commands.
For more usage information see the additional [README.md](src/CommandsCollection/general/static/README.md).
The main goals for the DCC are:
- reusable commands in several projects
- reusable functionalities within the commands
- standardization of commands in usage and style
- simplification and transparency of command execution
- customisation of the automated DCC process
Define one of the following project type within your `composer.json`:
- [TYPO3](src/CommandsCollection/typo3)
- [Symfony](src/CommandsCollection/symfony)
- [Drupal](src/CommandsCollection/drupal)
```json
"config": {
"dcc-type": "Symfony"
}
```
Add the post scripts in the composer.json:
```json
"scripts": {
"post-install-cmd": [
"Kmi\\DdevCommandsCollection\\Composer\\Scripts::updateCommands"
],
"post-update-cmd": [
"Kmi\\DdevCommandsCollection\\Composer\\Scripts::updateCommands"
]
}
```
Install from [packagist](https://packagist.org/packages/kmi/ddev-commands-collection) via composer:
```bash
$ composer req kmi/ddev-commands-collection
```
Add the following files to your local project git:
```bash
.ddev/
commands/
.gitignore
dcc-config.sh
```
__Note__: If your project structure differs from the example below and your `composer.json` and the ddev directory aren't on the same level, you can define the relative path to the ddev directory inside your `composer.json` like the following example:
```json
"config": {
"ddev-dir": "./../.ddev"
}
```
The automatic DCC process affects the following files/directories (marked as **bold**) inside your project (example structure for a project):
- `project/`
- `.ddev/`
- `commands/`
- `web`
- **dcc-cc**
- **dcc-composer-app**
- **dcc-composer-deployment**
- **dcc-console**
- **dcc-init**
- **dcc-release**
- **dcc-sync**
- **dcc-theme**
- `...`
- **faq**/
- **dcc-faq-web-sync.sh**
- `...`
- **scripts**/
- **dcc-colors.sh**
- `...`
- **.gitignore**
- **dcc-config.yaml**
- **dcc-config.sh**
- **README.md**
- `...`
- `config.yaml`
- `...`
- `app/` -- *Application directory*
- `composer.json`
- `composer.lock`
- `...`
- `composer.json` -- *Adapted composer file for DCC*
- `composer.lock`
- `...`
See the additional [README.md](src/CommandsCollection/general/static/README.md) for information about adjustments.