Giter Club home page Giter Club logo

druleton's Introduction

druleton

Author License : MIT

Set of bash scripts and configuration files to install, reset, upgrade, backup, restore and build a Drupal project without the need to have Core and Contributed code in the repository.

The name "druleton" is a combination of drupal and skeleton.

Installation

See the quick-start guide how to install druleton.

Commands

Druleton provides commands to create a new site and support in development and deployment.

Each command has a help section that explains the options for it. View the help by running the command with the -h switch.

Example:

$ bin/install -h

bin/init

The bin/init command is used to setup the druleton environment.

It will check the project file structure and create the missing parts.

It will download tools like composer and add them to the bin directory. It will also scan the config/bin directory if there are custom, project specific, commands and add them to the bin directory.

You can run this command anytime, it will update the tools and rescan the config/bin directory.

$ bin/init

More information about this command.

bin/install

The bin/install command will download Core & Contributed (modules, themes & libraries) as defined in the make file(s), and will install the website with the settings in the config/config.sh file.

When the installation is finished, a browser will be opened and you will be logged in as platform administrator (user 1).

If there is already a working installation, a backup of it will be taken.

$ bin/install

More information about this command.

bin/reset

The bin/reset command will do the same as install without downloading the Core and Contributed projects. Use this to reset an already installed website to its fresh-install state.

A backup will be taken before the reset is run.

The sites/default/settings.php file, the sites/default/files directory and the database will be removed before the site is reinstalled.

$ bin/reset

More information about this command.

bin/upgrade

The bin/upgrade command will download Core & Contributed code based on the make files and run the update-db command. Use this to update core and contributed to their latest version or to apply a patch.

A backup will be taken before the reset is run.

The existing settings.php, files directory and database will be kept.

$ bin/upgrade

More information about this command.

bin/build

The bin/build command will create a deployment package (code) in the /build directory.

$ bin/build

More information about this command.

bin/backup

The bin/backup command will take a backup of the web directory and the database. The backup will be stored in the backup directory.

You can limit the backup to just the web or files directory or just the database by passing them as arguments.

$ bin/backup

More information about this command.

bin/restore

The bin/restore command will list the available backups from the backup directory and let you choose which one to restore. It will restore the /web directory and the database.

If there is a working environment: a backup of it will be created before the restore is run.

$ bin/restore

More information about this command.

bin/composer

The bin/composer command is a wrapper around the composer.phar binary.

$ bin/composer

More information about this command.

bin/drush

The bin/drush command is a wrapper around drush. It will always run the drush command within the web directory.

$ bin/drush

More information about this command.

bin/coder

The bin/coder command is a wrapper around the phpcs (PHP Code Sniffer) binary. It has the proper default settings for the Drupal standards.

$ bin/coder

More information about this command.

More commands

Composer

The bin/init command will download and install composer locally. It can be called using following command:

$ bin/composer

Custom commands

It is possible to add your own, project specific, commands.

See the custom commands documentation.

Alter commands by implementing hooks

Each command has a set of steps it runs trough. All the code related to those steps are located in the bin and bin/src directories. This code should not be altered/hacked.

Druleton provides hooks that are called before and after each step so extra scripts can be added and run.

The hooks can be implemented only for specific environments by adding the environment name as postfix to the hook.

See hooks documentation.

druleton's People

Contributors

mpparsley avatar sgrame avatar zero2one avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.