{"id":21427993,"url":"https://github.com/redhat-developer-demos/rps-game","last_synced_at":"2025-07-14T10:31:41.917Z","repository":{"id":173339263,"uuid":"650613801","full_name":"redhat-developer-demos/rps-game","owner":"redhat-developer-demos","description":"Rock Paper Scissors game powered by Red Hat OpenShift AI","archived":false,"fork":false,"pushed_at":"2025-04-02T00:38:05.000Z","size":43823,"stargazers_count":10,"open_issues_count":1,"forks_count":8,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-04-08T06:51:10.466Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redhat-developer-demos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-07T12:44:16.000Z","updated_at":"2025-04-03T13:45:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"55d1c7ef-236a-439f-8186-6c9ef01b41b7","html_url":"https://github.com/redhat-developer-demos/rps-game","commit_stats":null,"previous_names":["redhat-developer-demos/rps-game"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/redhat-developer-demos/rps-game","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer-demos%2Frps-game","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer-demos%2Frps-game/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer-demos%2Frps-game/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer-demos%2Frps-game/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redhat-developer-demos","download_url":"https://codeload.github.com/redhat-developer-demos/rps-game/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer-demos%2Frps-game/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265280632,"owners_count":23739851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T22:09:33.756Z","updated_at":"2025-07-14T10:31:36.895Z","avatar_url":"https://github.com/redhat-developer-demos.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rock Paper Scissors Game\n\n![AI Build](https://github.com/redhat-developer-demos/rps-game/actions/workflows/build.ai.yaml/badge.svg)\n![Backend Build](https://github.com/redhat-developer-demos/rps-game/actions/workflows/build.backend.yaml/badge.svg)\n![Frontend Build](https://github.com/redhat-developer-demos/rps-game/actions/workflows/build.frontend.yaml/badge.svg)\n\nWelcome to the Rock Paper Scissors game powered by [Red Hat OpenShift AI](https://red.ht/openshift_ai)! :rocket:\n\nThis 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! \n\n\u003cdiv align=\"center\"\u003e\n\u003cimg width=\"33%\" src=\"roshambo-phone.png\" alt=\"Roshambo on iPhone\" title=\"Roshambo on iPhone\"\u003c/img\u003e\n\u003c/div\u003e\n\n## Architecture Overview\n\nThe Quarkus backend provides a configuration payload to the UI. This payload\nincludes a [feature flag](https://en.wikipedia.org/wiki/Feature_toggle) that\nwill enable or disable an image recognition feature. You can find this\nconfiguration in the Qukarus _application.properties_ file. Enabling this\nfeature will allow users to take pictures of their hand to select rock, paper,\nor scissors. The image is sent to a Python service (code in _roshambo-ai_ folder)\nthat uses a model provided by OpenShift AI to determine the user's selection.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg width=\"85%\" src=\"architecture.png\" alt=\"Roshambo Architecture\" title=\"Roshambo Architecture\"\u003c/img\u003e\n\u003c/div\u003e\n\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nBefore you begin, you will need to have the following installed:\n\n- Node.js (v18 or v20) and npm\n- Java Development Kit (v17)\n- Maven\n\nOptionally, you might want to the Quarkus backend upload captured images to AWS\nS3. This requires creating an S3 bucket and configuring an IAM user with write\naccess to the bucket. Check _roshambo-backend/README.md_ for more information.\n\n### Local Development\n\n- Clone the repository to your local machine.\n- Navigate to the root directory of the project.\n- Install frontend dependencies using `npm install` in the frontend directory (`roshambo-ui`).\n- Install backend dependencies using `mvn install` in the backend directory (`roshambo-backend`).\n- Start the Quarkus backend using `./mvnw quarkus:dev`.\n- Start the React development server using `npm run dev`.\n- Visit http://localhost:5173 in your web browser to view the application (view the README in the `roshambo-ui` folder for details about SSL and iOS Camera access)\n\n## Deployment on OpenShift\n\nRefer to the [redhat-developer-demos/rps-game-manifests repository](https://github.com/redhat-developer-demos/rps-game-manifests).\n\n## Built With\n\n- [React](https://react.dev) - The web framework used.\n- [TypeScript](https://www.typescriptlang.org) - The main language for the frontend.\n- [XState](https://xstate.js.org/docs/) - State management for the frontend, and bot players.\n- [Quarkus](https://quarkus.io) - Used for the backend.\n- [Tailwind CSS](https://tailwindcss.com) - Used for styling.\n\n## Contributing\n\nIf you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.\n\n## Authors\n\n- [Alex Soto Bueno](https://twitter.com/alexsotob) (Backend)\n- [Evan Shortiss](https://twitter.com/evanshortiss) (Frontend)\n- [Cedric Clyburn](https://twitter.com/cedricclyburn) (Frontend)\n- [Chris Chase](https://twitter.com/chaseredhat) (AI Model)\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the LICENSE.md file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-developer-demos%2Frps-game","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhat-developer-demos%2Frps-game","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-developer-demos%2Frps-game/lists"}