Skip to content

development.md

Latest commit

 

History

History
102 lines (67 loc) · 3.64 KB

development.md

File metadata and controls

102 lines (67 loc) · 3.64 KB

DevShop Development

Docker

This project contains scripts for launching DevShop on Docker for development purposes:

  • development-prepare.sh: Run this script first. It will prepare the needed source code for devshop, as well as build the containers needed.
  • development-launch.sh: This script is run automatically by development-prepare.sh to launch the containers and install Devmaster.
  • development-destroy.sh: This script removes all traces of the devshop containers and their volumes.

Vagrant

The Vagrantfile in this project is now deprecated, but is still included in the vagrant folder if you wish to use it.

It uses the install.sh file in this repo to provision the vagrant server.

This is the recommended install method for servers as well as vagrant boxes.

See Development with Vagrant for legacy instructions.

Dependencies

The only tools you need on your host machine to develop devshop are:

  • Git: Used to clone the source code.
  • PHP-CLI: Needed to run Drush.
  • Drush: Used to build the Drupal codebase on your host machine.
  • Docker version 1.10.0+.
  • Docker Compose version 1.6.0+.

  1. Install Git.

  2. Install Drush.

  3. Install Docker.

  4. Install Docker Compose.

  5. Clone this Repo and change to it's directory.

    git clone git@github.com:opendevshop/devshop.git
cd devshop

  6. Run development-prepare.sh script to clone the rest of the source code and prepare docker containers.

  7. That's it! Look for a one-time login link that looks like:

http://devshop.local.computer/user/reset/1/1475596064/EzLbpsTpSgKLJl7GmO0

The development-prepare.sh scripts and development-launch.sh scripts will remain open, following the docker logs. Press CTRL-C to cancel out of the logs if you wish.

More information on how to access the containers is output when you cancel the logs.

Repos

DevShop consists of a number of code repositories.

"DevShop": Main Project

github.com/opendevshop/devshop

If you want to develop the server setup, the standalone install script, the documentation, or improve the Vagrantfile, fork this repo.

Contains:

  • DevShop install script: install.sh
  • Ansible playbooks: playbook.yml, roles folder.
  • Documentation
  • Vagrantfile
  • build-devmaster.make file: used to build the devshop front-end. (Modify this file to use your fork of devmaster.)

"DevMaster": Drupal install profile for devshop front-end

github.com/opendevshop/devmaster

If you want to develop the front-end of devshop:

  1. Fork this repo (https://github.com/opendevshop/devshop), and create your own branch for your feature or bugfix.
  2. Edit build-devmaster.make file, and replace the devmaster url and branch with your forked repo url and branch like so:
projects[devmaster][type] = "profile"
projects[devmaster][download][type] = "git"
projects[devmaster][download][url] = "git@github.com:MYUSERNAME/devmaster.git"
projects[devmaster][download][branch] = "dev-MYBRANCH"

See the ./source/devmaster-1.x/profiles/devmaster folder for the fully built devmaster stack.

Help Improve Documentation

Think this can be improved? You can edit this file on GitHub and select "Create a new branch for this commit and start a pull request.".

Thanks!