lcp-compose

Introduction

lcp-compose is a command-line tool to build and deploy Points Loyalty Commerce Platform to a local docker engine for development and testing purposes.

This tool will:

Prerequisites

Recommended development environment for lcp-compose is as follows:

We recommend using the included vagrant box since it's cross-platform and with all dependencies pre-installed.

Install Vagrant

Head over to Vagrant's downloads page and install the appropriate package for your operating system.

Install Ansible

Ansible is required for initial bootstrapping of the developer VM.

Follow the instructions on the official install guide to set it up on your computer.

Start the Developer VM

Checkout lcp-compose from the git repository:

git clone https://github.com/Points/lcp-compose.git lcp-compose/

Change directory to lcp-compose/vagrant and execute vagrant up. This will start the process of provisioning the dev virtual machine. If you wish, you can explore the ansible playbook for provisioning under vagrant/ansible.

After the machine is provisioned, you can gain shell access by using vagrant ssh.

Note: If vagrant up command fails or if you've made a change to ansible playbook or the Vagrantfile, make sure to run vagrant provision and vagrant reload to update the VM.

Getting Started

See the installation guide.

Development

See the contribution guide