README.md

Deploy to your Local Workstation

Here we will outline the process to deploy this solution on your local workstation.

Prerequisites

Install the following packages:

1. Docker
   • Windows, use Docker Desktop
   • Mac, use Docker Desktop
   • Linux, use Docker Engine

     If on RHEL, Fedora, CentOS or Rocky Linux you may use Podman which is already installed. Though you will need to also install podman-compose.

2. Git

   Only required on Linux and Mac. For Windows see step 4 below.

3. Create the desired corresponding Watson API service, then collect the service credentials.

Run

1. Clone the Git repository.

   git clone https://github.com/Call-for-Code/Watson-API-Playground.git
   

2. Change to the ui folder under Watson-API-Playground repository.

   cd Watson-API-Playground
   

3. Edit the file deployment/docker/docker-compose.yaml adding the Watson API service credentials for the following environment variables.
   • SERVICE_BASE_URL
   • API_KEY
4. Start the application

   Add --build if a rebuild the base image is necessary. The first run will build the image.
   A restart of the container is necessary to pick up changes outside the src directory.

   • Docker

     docker compose -f deployment/docker/docker-compose.yaml up
     

   • Podman

     podman-compose -f deployment/docker/docker-compose.yaml up
     

View the application

In your browser, navigate to the following URL:

http://localhost:8080