feature: Add command to start projects in development mode

[ticean]

Resolves #97, #83
Impact: minor
Type: feature

Issue

There was no make command to start projects in development mode.

Solution

This continues the work that @trojanh started in #97. Thanks for the submission @trojanh!

Add make init-dev and make dev-<project-name> command to start projects in development mode.

This makes some additions to create init tasks that will configure project(s) for "development mode", which means that docker-compose.dev.yml is symlinked to docker-compose.override.yml in the project directory. The dev overrides configure the project to build and mount local code into the project. That's usually slower.

The README contains workflow suggestions.

I removed the global dev target that was originally proposed, but left the per-project dev-<project> tasks undocumented in the README. Is stopping enough? The README shows documents stopping (same as dev-<project>) but the explicit operations make it clear to user what's happening. Happy to document it in the README if we're confident the workflow will work for everyone and not trigger more support cases.

Breaking changes

None.

Testing

We had some discussion in #98. I think there was some confusion around the expected workflow. So here are testing instructions for a few cases:

Start Everything in Dev Mode

You probably don't want to do this anymore! It's slow and takes more resources.

1. git clone [email protected]:reactioncommerce/reaction-development-platform.git
2. cd reaction-development-platform
3. make init-dev
4. Make sure docker-compose.override.yml file gets created in the respective projects
5. Make sure the docker-compose runs using the local files and not using the image from Dockerhub

Switch a Single Project into Dev Mode

Using instructions from README.

1. git clone [email protected]:reactioncommerce/reaction-development-platform.git
2. cd reaction-development-platform
3. make init
4. Make sure all projects start in "production" mode, using pre-built images and no code mounts.
5. Follow README instructions to switch to dev mode.
6. Make sure docker-compose.override.yml file gets created in the respective projects
7. Make sure the docker-compose runs using the local files and not using the image from Dockerhub

Switch a Single Project into Dev Mode

Using experimental make dev-<project> target. It's undocumented in README until we have high confidence that it works well.

1. git clone [email protected]:reactioncommerce/reaction-development-platform.git
2. cd reaction-development-platform
3. make init
4. Make sure all projects start in "production" mode, using pre-built images and no code mounts.
5. Run make dev-<project>
6. Make sure docker-compose.override.yml file gets created in the respective projects
7. Make sure the docker-compose runs using the local files and not using the image from Dockerhub

Switch a Single Project into Production Mode

1. Follow above instructions to ensure a project is in dev mode.
2. Follow README instructions to switch to prod mode.
3. Make sure docker-compose.override.yml file is removed in the respective projects
4. Make sure the docker-compose runs using Dockerhub image and does not mount code.

[kieckhafer]

👍 was able to start up in dev mode, and unlink and link individual projects. Nice work!

[ticean]

🎉 Thanks @trojanh @focusaurus and @kieckhafer!