{"id":20672090,"url":"https://github.com/workarea-commerce/workarea-browse-option","last_synced_at":"2025-06-27T01:34:17.292Z","repository":{"id":56246590,"uuid":"203656654","full_name":"workarea-commerce/workarea-browse-option","owner":"workarea-commerce","description":null,"archived":false,"fork":false,"pushed_at":"2020-11-18T17:28:25.000Z","size":197,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-31T07:13:00.997Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workarea-commerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-21T20:07:20.000Z","updated_at":"2020-11-18T17:28:07.000Z","dependencies_parsed_at":"2022-08-15T15:20:50.619Z","dependency_job_id":null,"html_url":"https://github.com/workarea-commerce/workarea-browse-option","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/workarea-commerce/workarea-browse-option","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-browse-option","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-browse-option/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-browse-option/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-browse-option/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workarea-commerce","download_url":"https://codeload.github.com/workarea-commerce/workarea-browse-option/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-browse-option/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262173122,"owners_count":23270166,"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-16T20:31:53.163Z","updated_at":"2025-06-27T01:34:17.263Z","avatar_url":"https://github.com/workarea-commerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Workarea Browse Option\n================================================================================\n\nA Workarea Commerce plugin that enables the display of products by their various options (e.g. color) when browsing them in the Storefront.\n\n\nOverview\n--------------------------------------------------------------------------------\n\n* Allows each product to be \"broken out\" into multiple representations when browsing in the Storefront, based on a particular product option, such as color\n* Allows admins to choose which products \"browse by option\" and to choose the specific option for each product\n* Allows admins to choose a particular representation of the product (e.g. the blue one) when featuring it within a category or search results\n* Prevents representations of the same product from appearing in collections of related products (e.g. upsells)\n\nGetting Started\n--------------------------------------------------------------------------------\n\nAdd the gem to your application's Gemfile:\n\n```ruby\n# ...\ngem 'workarea-browse_option'\n# ...\n```\n\nUpdate your application's bundle.\n\n```bash\ncd path/to/application\nbundle\n```\n\nFeatures\n--------------------------------------------------------------------------------\n\n\n### Administration of Browse Options\n\n* When editing a product in the Admin (or bulk editing many), an administrator can choose a \"browses by\" option for that product\n* The UI for choosing this option is a select menu, which is populated with the keys of the details for all of the product's variants\n* When a value is selected for the browse option, the product is said to \"browse by option\" and is represented differently in Elasticsearch (see below)\n* Each product's attributes card in the Admin displays its browse option (if any)\n\n\n### Search Indexing \u0026 Browsing\n\n* Products that browse by option are stored as multiple documents (one per value of the selected option) within each Storefront search index\n* Each option-specific search document is built from only those variants of the product that match the particular option value (e.g. blue for color)\n* When browsing (e.g. search results and category listings), such products potentially appear in results multiple times (up to once per search document in that index)\n* Each representation of a product uses a relevant product image (if available), such as a blue image for the blue representation of the product\n* Clicking through any of the product's browse results takes the customer to the same product details (from Mongo)\n\n\n### State/Caching in the Storefront\n\n* If a product browses by option, the particular option value is persisted through the `:option` param when clicking through to the product's details\n* When a product browses by option and the `:option` param is set, the specific option value is used in the product's cache key, affecting show, summary, and pricing view caches\n\nWorkarea Commerce Documentation\n--------------------------------------------------------------------------------\n\nSee [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.\n\nLicense\n--------------------------------------------------------------------------------\n\nWorkarea Browse Option is released under the [Business Software License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-browse-option","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkarea-commerce%2Fworkarea-browse-option","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-browse-option/lists"}