fourkitchens/fire

There is no license information available for the latest version (2.0.2) of this package.

Maintainers

Details

github.com/fourkitchens/fire

Source

Issues

Installs: 1 483

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 12

Forks: 0

Open Issues: 8

2.0.2 2024-02-09 23:31 UTC

Requires

Unknown License c46895535f6870d935082c889bec02677711ccbb

This package is auto-updated.

Last update: 2024-04-19 00:15:58 UTC

README

FIRE

   )
  ) \
 / ) (
 \(_)/

=================

Fast Initialization and Rebuilding of Environments.

FIRE is a standardized set of commands to run local Drupal environments, regardless of which Docker wrapper you use (Lando or DDEV), and regardless of where the live site is hosted (Pantheon or Acquia). This means that every site that you work on will use the same commands for things like getting a fresh database (fire get-db). This makes it quicker and easier to get new people working on any of your sites.

Install

  1. Install the FIRE Launcher on your computer (Recommended but optional)
    https://github.com/fourkitchens/fire-launcher
  2. Install the commands package into your project
    composer require fourkitchens/fire --dev
  3. Create your fire.yml config file for the project
    fire init
  4. Edit fire.yml and adjust the configuration.
  5. Check if fire is working
    If you have installed the FIRE Launcher:
fire

otherwise:

./vendor/bin/fire

It should show you all the available FIRE commands.

  1. Edit your project's README.md file and point to our Project Documentation
    If your project has other requirements to run FIRE commands (e.g. does your project also require Node and NVM?), then be sure to also list those in your project's README.md.

Usage

With FIRE laucher installed:

Example:

fire build

Without the FIRE launcher installed:

Example:

./vendor/bin/fire build

Available commands:

  • env:start: Starts the local Docker based env (lando, ddev).

    alias: start

  • env:stop: Stops the local Docker based env (lando, ddev).

    alias: stop

  • local:build: Builds your Drupal Site from the scratch.

    Alias: local-build, build

    Options:

    --no-db-import: Ignores the database import process (Download & Import).

    --no-db-download: Ignores ONLY the DB download, data will be imported from your existing db backup file.

    -f, --get-files: Gets the Files from the remote server.

  • local:build:drush-commands: Drush Build commands - updb , cr, cim , cr, deploy:hook

    Alias build-drush

  • local:build:js: Builds Project JS Dependencies (Projects Root).

    Alias: build-js

  • local:build:php: Builds Project PHP Dependencies.

    Alias: build-php

  • local:build:theme: Builds Projects theme.

    Alias build-theme

  • local:configure:export: Exports sites configuration - none interaction required.

    Alias: configure-export|configure_export|cex

  • local:configure:import: Imports sites configuration - none interaction required.

    Alias: configure-import|configure_import|cim

  • local:drush: Drush proxy for local envs.

    Alias: drush

    Arguments:

    args: drush you would like to execute.

  • local:get-db: Get the database for local env.

    Alias: get-db|db-get|getdb|dbget|get_db|db_get|local:db:get|local:get:db

  • local:get-files: Downloads the sites files from the remote source (Pantheon, acquia).

    Alias: get-files|files-get|getfiles|filesget|get_files|files_get|pull-files|pull_files|local:file:get|local:get:files

    Options:

    --no-download: Reuse your existing files copy in the reference folder and placing them in the files folder (Pantheon only).

  • local:import-db: Import database for local envs.

    Alias: import-db|db-import|importdb|dbimport|import_db|db_import

  • local:setup: Setups your project from scratch (lando, ddev), all your data will be destroy and rebuild.

    Alias: setup

    Options:

    --no-db-import: Ignores the database import process (Download & Import).

    --no-db-download: Ignores ONLY the DB download, data will be imported from your existing db backup file.

    -f, --get-files: Gets the Files from the remote server.

  • xdebug:enable: Configures your local envs Xdebug to work with your prefered Code editor.

    Alias: xd-en

Configuration

Into your project root create a file called: fire.yml and iside of it speficify your global project settings.

If you need to override some of the global settings latter for a specific env you can create fire.local.yml and there override as many variables as you want.

Configuration variables:

  • local_environment : Optional setting, the system will automatically detected your local env, currently available: ddev, lando.

  • local_fe_theme_name: Optional setting, the system will try to automatically get your theme, but you can always specify the theme you require to use.

  • local_theme_build_script: NPM script you are using to build your theme.

  • remote_platform: Your Sites Remote platform. Currently available: pantheon, acquia

  • remote_sitename: Remote plaform Sites machine name.

  • remote_canonical_env: Remote platform canonical env (The env to pull files and database from).

Development

  • Install the FIRE package from the source.
composer require fourkitchens/fire --dev --prefer-install=source

Dev backgroud

We are using Robo as Framework to develop this tool.