reactioncommerce / Reaction Development Platform

Overview

Reaction Platform is a customizable, real-time, reactive commerce solution. This repository is the quickest way to get started with the Reaction API and its supporting services in a local development environment.

Features

• A modern, enterprise-ready, real-time commerce platform.
• A microservices based architecture.
• Docker based development environment.
• Launched and configured with a single CLI command.

Prerequisites

• GNU Make
  • MacOS and Linux users will have a suitable version bundled with the OS
• Bourne Shell and POSIX tools (sh, grep, sed, awk, etc)
  • MacOS and Linux users will have a suitable version bundled with the OS
• Git
• Docker | Docker for Mac | Docker for Windows
• A GitHub account with a configured SSH key is not required by default, but necessary when using custom, private Github repositories.

Getting started

Clone this repository, and then run make in the reaction-development-platform directory. If all goes well, it will take some time to download and start all of the components, but when it's done you'll have the entire Reaction application running on your computer through Docker. Individual services are cloned as child directories within this project.

git clone [email protected]:reactioncommerce/reaction-development-platform.git
cd reaction-development-platform
make

Behind the scenes make is

• checking that dependencies are present
• cloning sub-projects from GitHub
• downloading Docker images
• starting services

These services will be running when the initial make command is complete:

If the make command fails at some point, you can run or rerun it for specific services with:

make init-<project-name>

Example:

make init-example-storefront

Project Commands

These are the available make commands in the reaction-platform root directory.

Customizing Configuration

The development platform runs the latest version of Reaction by default, but it's possible to select a specific version, or to customize an existing release version.

How Configuration Works

The Reaction development platform uses make to run tasks. make is aware of the task dependency tree and ensures that all required dependencies are met when running a task. The main tasks and functionality for make are configured in Makefile.

Configurations that may change are extracted into config.mk. This file is checked in to source control and should not be modified. It is always configured for the latest Reaction release.

If a file named config.local.mk exists then it will be loaded after config.mk. Settings in config.local.mk will override those set in config.mk. It is ignored by source control.

Running a Specific Reaction Release Version

Configurations for specific Reaction releases (since v3.0.0) are located in config/reaction-oss. You may symlink or copy any release configuration to config.local.mk.

For example, this command will configure the platform to run v3.0.4:

ln -s config/reaction-oss/reaction-v3.0.4.mk config.local.mk
make

Running A Customized Installation

You may customize your Reaction installation by modifying config.local.mk. It's easiest to start with an existing release configuration file and modify it as needed. In this way you can:

• Add new sub-projects
• Remove sub-projects
• Update the git origin for a sub-project
• Change the default branch for a sub-project
• Customize the lifecycle hooks directory to run custom scripts for automation

Configuration files store in config/local are ignored by git. It's a convenient place to store local files for quick development. If you are sharing files with a team then you may want to keep your configuration files in a separate git repository or in shared network storage.

The only requirement to override configuration is that you need to put a file into place at config.local.mk, so it is possible to copy or symlink a file from anywhere in your system.

Examples:

# Use a file in the config/local directory
ln -s config/local/my-custom-config.mk config.local.mk
make

# Use a file in the config/local directory
ln -s /path/on/my/system/reactionconfig.mk config.local.mk
make

Updating Local Branches to Match Config

If you are using the Reaction development platform for development, then you will need to update your local branch to get the latest at some point. The update-checkouts command will perform this operation.

make update-checkouts

The command is safe. It will halt if there are uncommitted changes in git before doing anything. You may commit, stash or drop those changes.

Running Particular Git Branches

After you've done the "Getting Started" steps and have the latest Reaction system running, you may need to switch to and run a certain branch/tag in one or more of the sub-projects.

To check out and run a certain branch or tag for a project, stop the project, run make checkout-<project-name> <git-tag-or-branch-name>, and then init the project again.

Example:

make stop-example-storefront
make checkout-example-storefront release-v3.0.0
make init-example-storefront

If you're getting unexpected results, cd into the sub-project directory and do a git pull to verify you're on the latest commit from that branch. If you're changing code files, see the "Running From Code For Development" section below.

Running From Code For Development

To ensure they start quickly, all Reaction projects are configured (in their docker-compose.yml file) to run from the latest published Docker image. This means that if you change code files, you will not see your changes reflected in the running application.

To install the whole platform in development mode:

Run make init-dev (instead of make).

Doing this takes time to install and will consume more resources.

To switch over to development mode for a single project:

make stop-<project-name>
make dev-link-<project-name>
make <start-project-name>

If you run into trouble with the above command, run make clean-<project-name> and then make init-dev-<project-name>.

To switch back to production mode for a single project:

make stop-<project-name>
make dev-unlink-<project-name>
make <start-project-name>

If you run into trouble with the above command, run make clean-<project-name> and then make init-<project-name>.

Networked Services

User-defined Docker networks are used to connect the Reaction services that run as separate Docker Compose projects. With this configuration, each of the projects can be launched independently using Docker Compose.

While the projects can be launched independently they may have network dependencies that are required to function correctly. The platform Makefile will launch services for you if you start it all together. You are free to manually start a single service but you will need to ensure dependencies are running.

Network Naming Strategy

All projects must list reaction.localhost as an external network in their docker-compose configuration. The make commands will ensure that this network exists. Choose a unique enough name for your service that you can be reasonably sure it won't conflict with another Reaction service.

When you need to communicate with one service from another over the internal Docker network, use <service-name>.reaction.localhost as the hostname.

Documentation

You may refer to each sub-project's README for additional operation details.

For tips on developing with Docker, read our Docker docs.

Latest Releases

The following table provides the most current version of each project used by this platform:

Developer Certificate of Origin

We use the Developer Certificate of Origin (DCO) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing-off all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed:

Signed-off-by: Jane Doe <[email protected]>

You can sign-off your commit automatically with Git by using git commit -s if you have your user.name and user.email set as part of your Git configuration.

We ask that you use your real full name (please no anonymous contributions or pseudonyms) and a real email address. By signing-off your commit you are certifying that you have the right to submit it under the GNU GPLv3 Licensed.

We use the Probot DCO GitHub app to check for DCO sign-offs of every commit.

If you forget to sign-off your commits, the DCO bot will remind you and give you detailed instructions for how to amend your commits to add a signature.

License

Copyright © GNU General Public License v3.0