Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.55 KB

README.md

File metadata and controls

43 lines (28 loc) · 2.55 KB
Raw

Origin Box

Origin Box is a container setup for running multiple Origin components simultaneously in a single environment.

Use Cases

Origin Box has several intended use cases:

  • Demonstration: We want to make it as easy as possible for people to spin up their own Origin environment, emphasizing that this platform is truly open and decentralized.
  • Development: While we do our best to keep our components as independent as possible, ultimately they are all designed to function together as one unit. For development we do try to stub external components as much as possible, but this has its practical limits. It is often beneficial to be able to do development in an environment where all of the components are running. It can be tricky to get all of the various components synchronized on your local machine. Origin Box manages this complexity.
  • End-to-end Testing: Currently we do not have any automated end-to-end tests. We rely heavily on manual testing. Having one environment where all of our components are running together will hopefully make it easier for us to set up end-to-end testing when we are ready to do that.

Supported Components

Origin Box currently supports the following components:

System Requirements

  • Docker version 18 or greater: docker --version
  • Git: git --version
  • Unix-based system (OSX or Linux) needed to run the bash scripts

Usage

  1. Run the setup script (from origin-box root directory): ./scripts/setup-bridge.sh

  2. Run the start script: ./scripts/start-bridge.sh

  3. Access the CLI: ./scripts/bash-bridge.sh

You may now edit the source code using your favorite editor in the ignored directories (currently dapp, js, and bridge). These are just normal git repositories that get cloned as part of the scripts/setup.sh script, so you can treat them as you would any other git repository. You can make changes, commit them, and change branches - and the container will be automatically kept in sync.

However, non-git related actions should be performed from within the container. For example, running any sort of npm command (e.g. npm test) should be done from within the container cli. The same applies for python commands.

pm2

Currently we're using pm2 to automatically start and manage core processes for all of the components. You can run pm2 list from within the container cli to see all currently running processes.