Skip to content

Commit

Permalink
doc: add architecture and CI status to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
evanshortiss committed Oct 12, 2023
1 parent edadee2 commit b10abd7
Show file tree
Hide file tree
Showing 3 changed files with 1,651 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Rock Paper Scissors Game

![AI Build](https://github.com/redhat-developer-demos/rps-game/actions/workflows/build.ai.yaml/badge.svg)
![Backend Build](https://github.com/redhat-developer-demos/rps-game/actions/workflows/build.backend.yaml/badge.svg)
![Frontend Build](https://github.com/redhat-developer-demos/rps-game/actions/workflows/build.frontend.yaml/badge.svg)

Welcome to the Rock Paper Scissors game powered by [Red Hat OpenShift AI](https://red.ht/openshift_ai)! :rocket:

This game uses a Quarkus backend and a React frontend. The game integrates machine learning models to process your move, giving it a modern twist to the classic game!
Expand All @@ -8,6 +12,21 @@ This game uses a Quarkus backend and a React frontend. The game integrates machi
<img width="33%" src="roshambo-phone.png" alt="Roshambo on iPhone" title="Roshambo on iPhone"</img>
</div>

## Architecture Overview

The Quarkus backend provides a configuration payload to the UI. This payload
includes a [feature flag](https://en.wikipedia.org/wiki/Feature_toggle) that
will enable or disable an image recognition feature. You can find this
configuration in the Qukarus _application.properties_ file. Enabling this
feature will allow users to take pictures of their hand to select rock, paper,
or scissors. The image is sent to a Python service (code in _roshambo-ai_ folder)
that uses a model provided by OpenShift AI to determine the user's selection.

<div align="center">
<img width="85%" src="architecture.png" alt="Roshambo Architecture" title="Roshambo Architecture"</img>
</div>


## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Expand All @@ -20,9 +39,9 @@ Before you begin, you will need to have the following installed:
- Java Development Kit (v17)
- Maven

Optionally, you might want to the Quarkus backend upload captures images to AWS
Optionally, you might want to the Quarkus backend upload captured images to AWS
S3. This requires creating an S3 bucket and configuring an IAM user with write
access to the bucket. Check the backend README for more information.
access to the bucket. Check _roshambo-backend/README.md_ for more information.

### Local Development

Expand Down
Loading

0 comments on commit b10abd7

Please sign in to comment.