Skip to content

FoxComm/highlander

Repository files navigation

Highlander

FoxCommerce has be acquired by the SHOP Cooperative!

Highlander is still in active use and its development is being maintained as part of the SHOP Protocol. However, the mono repo has been broken up into its various services.

Please proceed to wiki for more detailed info.

Development Setup

From highlander directory: git config core.hooksPath $PWD/utils/git-hooks

Development Environment

The simplest way to get started is setup a personal developer appliance in Google Cloud that runs the entire system. It's really easy, though you'll probably want to grab a coffee the first time you run it - it has a lot to do!

Install Prerequisites

Google Compute VM

  1. Ask one of DevOps guys for Ansible Vault password and OpenVPN keys + client configuration.

  2. Generate your SSH key for GCE and put the public key to project metadata.

  3. Generate Google service account key and download it in JSON format to your machine (role: Owner).

  4. Install Ansible dependencies by running:

    $ make prepare
    
  5. Run config generator, required for Ansible. You'll be prompted for you service account e-mail, JSON/SSH private key absolute locations, and optional: custom instance name (string) and additional IC apps for analytics (True/False).

    $ make config
    
  6. You're ready to spin up the machine! Do it by running (will take few minutes):

    $ make up
    

Deploying Custom Branches

Please refer to related wiki page for more information.

FoxCommerce Software Relationships

Logical relationships between services and software.

alt text

Physical model.

alt text

License

MIT