{"id":18554522,"url":"https://github.com/oracle/coherence-helidon-sockshop-sample","last_synced_at":"2025-06-22T14:04:58.946Z","repository":{"id":40793304,"uuid":"367161367","full_name":"oracle/coherence-helidon-sockshop-sample","owner":"oracle","description":"Coherence Helidon Sockshop Demo","archived":false,"fork":false,"pushed_at":"2025-05-16T19:31:04.000Z","size":44134,"stargazers_count":8,"open_issues_count":0,"forks_count":15,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-05-16T20:32:34.550Z","etag":null,"topics":["coherence","helidon","sockshop"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-05-13T20:03:28.000Z","updated_at":"2025-05-16T19:31:04.000Z","dependencies_parsed_at":"2025-04-30T17:32:21.959Z","dependency_job_id":"1ec7a71a-25f0-40d4-8d26-1ac00cd07ea1","html_url":"https://github.com/oracle/coherence-helidon-sockshop-sample","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/oracle/coherence-helidon-sockshop-sample","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-helidon-sockshop-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-helidon-sockshop-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-helidon-sockshop-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-helidon-sockshop-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/coherence-helidon-sockshop-sample/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Fcoherence-helidon-sockshop-sample/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261304247,"owners_count":23138294,"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":["coherence","helidon","sockshop"],"created_at":"2024-11-06T21:22:32.635Z","updated_at":"2025-06-22T14:04:53.926Z","avatar_url":"https://github.com/oracle.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coherence Helidon Sock Shop \n\nThis project is an implementation of a stateful, microservices based application that\nuses [Oracle Coherence CE](https://coherence.community/) as a scalable embedded data\nstore, and [Helidon MP](https://helidon.io/) as application framework.\n\nThe application is an online store that sells socks, and is based\non the [SockShop Microservices Demo](https://microservices-demo.github.io)\noriginally written and published under Apache 2.0 license by [Weaveworks](https://go.weave.works/socks).\n\nYou can see a working demo of the original application [here](http://socks.weave.works/).\n\nThis demo still uses the original front end implementation provided by Weaveworks,\nbut all back end services have been re-implemented from scratch using Helidon MP \nand Oracle Coherence, in order to showcase Coherence integration with Helidon, and\nEclipse MicroProfile in general.\n\nWe also provide the implementations of the same application that use Spring Boot or Micronaut \nas the application framework, in case one of those is your framework of choice.\n\n* [Coherence Spring Sock Shop](https://github.com/oracle/coherence-spring-sockshop-sample)\n* [Coherence Micronaut Sock Shop](https://github.com/oracle/coherence-micronaut-sockshop-sample)\n\n# Table of Contents\n\n* [Architecture](#architecture)\n* [Project Structure](#project-structure)\n* [Pre-Requisites](#pre-requisites)\n* [How to Run](#how-to-run)\n* [Complete Application Deployment](./doc/complete-application-deployment.md)\n* [Alternate Coherence Topologies](./k8s/alternatives/topologies.md)\n* [Integrating with Oracle OCI Application Performance Monitoring (APM)](./doc/oracle-cloud-apm.md)\n* [Development](./doc/development.md)\n* [License](#license)\n\n\n## Architecture\n\nThe application consists of 6 back end services (rewritten from the ground up on top of\nHelidon, implementing the API that the legacy `front-end` service expects).\n\n![Architecture Diagram](./doc/images/architecture.png)\n\n- **[Product Catalog](./catalog)**, which provides \nREST API that allows you to search product catalog and retrieve individual product details;\n\n- **[Shopping Cart](./carts)**, which provides \nREST API that allows you to manage customers' shopping carts;\n\n- **[Orders](./orders)**, which provides REST API \nthat allows customers to place orders;\n\n- **[Payment](./payment)**, which provides REST API \nthat allows you to process payments;\n\n- **[Shipping](./shipping)**, which provides REST API \nthat allows you to ship orders and track shipments;\n\n- **[Users](./users)**, which provides REST API \nthat allows you to manage customer information and provides registration and \nauthentication functionality for the customers.\n\nYou can find more details for each service within documentation pages for individual\nservices, which can be accessed using the links above.\n\n## Project Structure\n\nEach back end service described above has its own GitHub repo, so it can be versioned\nand released independently of other services. \n\nIn addition to that, there is also a main \n[Sock Shop](.) repository (the one you are \ncurrently in), which contains Kubernetes deployment files for the whole application, \ntop-level POM file which allows you to easily build the whole project and import it \ninto your favorite IDE, and a _bash_ script that makes it easy to check out and update \nall project repositories at once.\n\n## Pre-Requisites\n\n1. Latest version of `kubectl` available from https://kubernetes.io/docs/tasks/tools/.\n2. Docker or Rancher\n3. A remote or local Kubernetes cluster - Min 1.16+\n4. Maven 3.8+ and JDK 17\n\n## How to Run\n\nKubernetes scripts depend on Kustomize, so make sure that you have a newer \nversion of `kubectl` that supports it (at least 1.16 or above).\n\nThe easiest way to try the demo is to use Kubernetes deployment scripts from this repo. \n\nIf you do, you can simply run the following command from the `coherence-helidon-sockshop-sample` directory.\n\n* Install the Coherence Operator\n\nInstall the Coherence Operator using the instructions in the [Coherence Operator Quick Start](https://oracle.github.io/coherence-operator/docs/latest/#/docs/about/03_quickstart) documentation.\n\n\n* **Installing a Back-end**\n\nCreate a namespace in Kubernetes called `sockshop`.\n\n```bash\nkubectl create namespace sockshop\n```\n\nInstall the back-end into the `sockshop` namespace.\n\n```bash\nkubectl apply -k k8s/coherence --namespace sockshop\n```\n\nTIP: You can see the state of the pods using:\n\n```bash\nkubectl --namespace sockshop get pods\n```\n\n### (Optional) Install the Original WeaveSocks Front End\n\n\u003e Warning: The original WeaveSocks Front End has a few bugs, as well as some security issues, \n\u003e and it hasn't been actively maintained for a few years. However, if you want to deploy\n\u003e it nevertheless to see how it interacts with our back-end services, please follow\n\u003e the steps below.\n\nInstall the `front-end` service by running the following command:\n\n```bash\nkubectl apply -f k8s/optional/original-front-end.yaml --namespace sockshop\n```\n\nPort-forward to the `front-end` UI using the following\n\n```bash\nkubectl port-forward --namespace sockshop service/front-end 8079:80\n```\n\n\u003e Note: If you have installed into a namespace then add the `--namespace` option to all `kubectl` commands in these instructions.\n\nYou should be able to access the home page for the application by pointing your browser to http://localhost:8079/.\n\nYou should then be able to browse product catalog, add products to shopping cart, register as a new user, place an order,\nbrowse order history, etc.\n\nOnce you are finished, you can clean up the environment by executing the following:\n\n```bash\nkubectl delete -f k8s/optional/original-front-end.yaml --namespace sockshop\nkubectl delete -k k8s/coherence --namespace sockshop\n```\n\n### Scale Back-End\n\nIf you wish to scale the back-end you can issue the following command\n\nScale only the orders microservice\n```bash\nkubectl --namespace sockshop scale coherence/orders --replicas=3\n```\n\nOr alternatively scale all the microservices\n```bash\nfor name in carts catalog orders payment shipping users\n    do kubectl --namespace sockshop scale coherence/$name --replicas=3\ndone\n```\n\n## Complete Application Deployment\n\nThe [How to Run](#how-to-run) above shows how you can run the application locally, but that may not\nbe enough if you want to experiment by scaling individual services, look at tracing data in Jaeger,\nmonitor services via Prometheus and Grafana, or make API calls directly via Swagger UI.\n\nTo do all of the above, you need to deploy the services into a managed Kubernetes cluster\nin the cloud, by following the same set of steps described above (except for port forwarding,\nwhich is not necessary), and performing a few additional steps.\n\n [Go to Complete Application Deployment section](./doc/complete-application-deployment.md)\n\n## Development\n\nIf you want to modify the demo, you will need to check out the code for the project, build it\nlocally, and (optionally) push new container images to the repository of your choice.\n\n [Go to Development section](./doc/development.md)\n \n## Contributing\n\nThis project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)\n\n## Security\n\nPlease consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process\n\n## License\n\nThe Universal Permissive License (UPL), Version 1.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Fcoherence-helidon-sockshop-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Fcoherence-helidon-sockshop-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Fcoherence-helidon-sockshop-sample/lists"}