The quickest way to run Reaction and its supporting services.
Clone or download
focusaurus Merge pull request #44 from reactioncommerce/fix-git-checkout-directory
fix: missing semicolon and correct checkout directory
Latest commit 4f84046 Jan 11, 2019

README.md

Overview

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

Features

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

Project Structure

Reaction Platform is built with a microservices architecture. This project provides the tooling to easily orchestrate the services in a local development environment.

Platform services will be cloned as child directories within this project.

Prerequisites

Getting started

First, clone this repository.

git clone git@github.com:reactioncommerce/reaction-platform.git

cd reaction-platform

Bootstrapping

From within the project directory run:

make

This process may take some time. Behind the scenes make is

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-reaction-next-starterkit

Bootstrapping with Particular Git Branches

The normal bootstrapping process will give you the latest released versions of the platform subprojects and is the recommended configuration for regular development. However, if you know you require a particular previous release or alternative git branch, you can take the following steps to bring up the platform with the particular versions you need. These steps are an alternative to the standard bootstrapping approach, you should do one or the other, not both.

From the project directory run

make clone

Within the necessary subproject directory or directories run the git checkout <your-release-tag-or-branch> commands you need to get the specific subproject versions you need checked out.

Example:

cd reaction-next-starterkit
git checkout develop

Then run the following

cd .. # cd into reaction-platform
make

This will proceed with the bootstrapping process using the versions you have explicitly checked out

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

Platform networks in the Docker environment should be named as *.reaction.localhost. The localhost TLD is reserved and guaranteed to not conflict with a real TLD.

Network List

Network Description
api.reaction.localhost GraphQL and API traffic between services.
auth.reaction.localhost Authentication and authorization services.

Services

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

Service Description
OAuth2 Server (Hydra) (http://localhost:4444) ORY Hydra OAuth2 token server.
Reaction Meteor (http://localhost:3000) The Reaction Meteor application, which includes the server API and the Meteor UI client.
Reaction NextJS Storefront (http://localhost:4000) A starter Reaction storefront UI built with Next.JS.

GraphQL Interface

After running make start, you should be able to explore the GraphQL API at http://localhost:3000/graphiql. See GraphiQL docs

Project Commands

These commands are used to control the system as a whole.

Run these commands from the reaction-platform project root directory.

Command Description
make Boostraps the entire Reaction development environment in Docker.
make stop Stops all containers.
make start Starts all containers.
make rm Removes all containers. Volumes are not removed.
make clean Removes all containers, networks, and volumes. Any volume data will be lost.
make init-<project-name> Example: make init-reaction-next-starterkit. Does clone/setup for a single project.

Documentation

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

Sub-project Documentation
reaction Reaction Documentation
reaction-hydra reaction-hydra, ory/hydra
reaction-next-starterkit Starterkit docs

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

License

Copyright © GNU General Public License v3.0