development.md

stream-producer development

The following instructions are used when modifying and building the Docker image.

Prerequisites for development

🤔 The following tasks need to be complete before proceeding. These are "one-time tasks" which may already have been completed.

1. The following software programs need to be installed:
   1. git
   2. make
   3. docker

Clone repository

For more information on environment variables, see Environment Variables.

1. Set these environment variable values:

   export GIT_ACCOUNT=senzing
   export GIT_REPOSITORY=stream-producer
   export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
   export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
   

2. Using the environment variables values just set, follow steps in clone-repository to install the Git repository.

Build Docker image

1. Option #1: Using docker command and GitHub.

   sudo docker build \
     --tag senzing/stream-producer \
     https://github.com/senzing/stream-producer.git#main
   

2. Option #2: Using docker command and local repository.

   cd ${GIT_REPOSITORY_DIR}
   sudo docker build --tag senzing/stream-producer .
   

3. Option #3: Using make command.

   cd ${GIT_REPOSITORY_DIR}
   sudo make docker-build
   

   Note: sudo make docker-build-development-cache can be used to create cached Docker layers.