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.
- A modern, enterprise-ready, real-time commerce platform.
- A microservices based architecture.
- Docker based development environment.
- Launched and configured with a single CLI command.
- 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
- A GitHub account with a configured SSH key
- Docker | Docker for Mac | Docker for Windows
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 git@github.com:reactioncommerce/reaction-development-platform.git
cd reaction-development-platform
makeBehind 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:
| Service | Description |
|---|---|
| OAuth2 Server (Hydra) (http://localhost:4444) | ORY Hydra OAuth2 token server. |
| Reaction Identity (http://localhost:4100) | The OAuth2-compatible user interface for Reaction Identity, such as login and registration. |
| Reaction API (http://localhost:3000) | The Reaction API, which includes a GraphQL endpoint. See GraphQL Playground. |
| Reaction Admin (http://localhost:4080) | A user interface for administrators and shop managers to configure shops, manage products, and process orders. |
| Example Storefront (http://localhost:4000) | An example Reaction storefront UI built with Next.JS. |
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-storefrontThese are the available make commands in the reaction-platform root directory.
| Command | Description |
|---|---|
make |
Bootstraps the entire Reaction development environment in Docker. Projects will use production Docker images and code. |
make init-<project-name> |
Example: make init-example-storefront. Does clone/setup for a single project. |
make init-dev |
Boostraps the entire Reaction development environment in Docker. Projects will use development configuration. |
make init-dev-<project-name> |
Example: make init-dev-example-storefront. Does clone/setup for a single project and configures it with a development configuration. |
make stop |
Stops all containers. |
make stop-<project-name> |
Example: make stop-example-storefront. Stops all containers for a single project. |
make start |
Starts all containers. |
make start-<project-name> |
Example: make start-example-storefront. Starts all containers for a single project. |
make dev-<project-name> |
Example: make dev-example-storefront. Starts all containers for a single project in development mode. |
make dev-link |
Creates docker-compose.override.yml symlinks for development in all projects. |
make dev-link-<project-name> |
Example: make dev-link-example-storefront. Creates development symlinks for a single project. |
make dev-unlink |
Removes docker-compose.override.yml symlinks from all projects. |
make dev-unlink-<project-name> |
Example: make dev-unlink-example-storefront. Removes the docker-compose.override.yml symlink for a single project. |
make rm |
Removes all containers. Volumes are not removed. |
make rm-<project-name> |
Example: make rm-example-storefront. Removes all containers for a single project. Volumes are not removed. |
make checkout-<project-name> <git-tag-or-branch-name> |
Example: make checkout-example-storefront release-v3.0.0. Does git checkout for a sub-project. See "Running Particular Git Branches" below. |
make clean |
Removes all containers, networks, and volumes. Any volume data will be lost. |
make clean-<project-name> |
Example: make clean-example-storefront. Removes all containers, networks, and volumes for a single project. Any volume data will be lost. |
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-storefrontIf 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.
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.
Run make init-dev (instead of make).
Doing this takes time to install and will consume more resources.
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>.
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>.
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.
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.
You may refer to each sub-project's README for additional operation details.
| Sub-project | Description | Documentation |
|---|---|---|
reaction |
GraphQL API | Reaction API Documentation |
reaction-hydra |
Authentication server | Reaction Hydra Readme, Ory Hydra docs |
reaction-identity |
Identity service | Reaction Identity Readme |
reaction-admin |
Classic Admin UI | Reaction Admin Readme |
example-storefront |
Example Storefront | Example Storefront docs |
For tips on developing with Docker, read our Docker docs.
The following table provides the most current version of each project used by this platform:
| Project | Latest release / tag |
|---|---|
| reaction-development-platform | 3.0.3 |
| reaction | 3.3.0 |
| reaction-hydra | 3.0.0 |
| reaction-identity | 3.0.0 |
| example-storefront | 3.0.0 |
| reaction-admin (beta) | 3.0.0-beta.5 |
| api-migrations | 3.3.0 |
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 <jane.doe@example.com>
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.
Copyright © GNU General Public License v3.0