{"id":20604535,"url":"https://github.com/virtocommerce/vc-module-x-cms","last_synced_at":"2026-01-27T12:01:45.707Z","repository":{"id":247429246,"uuid":"816208960","full_name":"VirtoCommerce/vc-module-x-cms","owner":"VirtoCommerce","description":"The X-CMS module serves as a component for managing and delivering dynamic content within the system. It provides capabilities for creating, organizing, and presenting various types of content.","archived":false,"fork":false,"pushed_at":"2026-01-12T15:11:01.000Z","size":95,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":8,"default_branch":"dev","last_synced_at":"2026-01-12T21:26:25.211Z","etag":null,"topics":["cms","graphql","xapi"],"latest_commit_sha":null,"homepage":"","language":"C#","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/VirtoCommerce.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-17T09:06:11.000Z","updated_at":"2026-01-07T16:06:37.000Z","dependencies_parsed_at":"2024-07-08T19:15:26.885Z","dependency_job_id":"64039db4-c45f-42e9-a95c-90d8b55e901d","html_url":"https://github.com/VirtoCommerce/vc-module-x-cms","commit_stats":null,"previous_names":["virtocommerce/vc-module-x-cms"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/VirtoCommerce/vc-module-x-cms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtoCommerce%2Fvc-module-x-cms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtoCommerce%2Fvc-module-x-cms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtoCommerce%2Fvc-module-x-cms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtoCommerce%2Fvc-module-x-cms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VirtoCommerce","download_url":"https://codeload.github.com/VirtoCommerce/vc-module-x-cms/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VirtoCommerce%2Fvc-module-x-cms/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28812744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T11:52:46.759Z","status":"ssl_error","status_checked_at":"2026-01-27T11:52:35.059Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cms","graphql","xapi"],"created_at":"2024-11-16T09:23:27.995Z","updated_at":"2026-01-27T12:01:45.665Z","avatar_url":"https://github.com/VirtoCommerce.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Virto Commerce CMS Experience API (xCMS) Module [![CI status](https://github.com/VirtoCommerce/vc-module-x-cms/workflows/Module%20CI/badge.svg?branch=dev)](https://github.com/VirtoCommerce/vc-module-x-cms/actions?query=workflow%3A\"Module+CI\") [![Quality gate](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-x-cms\u0026metric=alert_status\u0026branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-x-cms) [![Reliability rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-x-cms\u0026metric=reliability_rating\u0026branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-x-cms) [![Security rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-x-cms\u0026metric=security_rating\u0026branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-x-cms) [![Sqale rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-x-cms\u0026metric=sqale_rating\u0026branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-x-cms)\n\n## Overview\n\nThe Virto Commerce CMS Experience API (xCMS) Module is a headless content delivery layer for Virto Commerce, focused on exposing CMS data via the Experience API (xAPI).  \nIt provides a unified GraphQL interface for dynamic content, pages, and page builder experiences, optimized for storefronts and composable frontends.\n\n### Architecture\n\nThe module is built on top of:\n\n- `VirtoCommerce.ContentModule.Core` – content storage and assets\n- `VirtoCommerce.PageBuilderModule.Core` – page builder blocks and layouts\n- `VirtoCommerce.Pages.Core` – pages and routing\n- `VirtoCommerce.Xapi.Core` – Experience API infrastructure\n\nKey architectural concepts:\n\n- **Headless content delivery**: All content is accessed via xAPI (GraphQL) instead of direct CMS APIs.\n- **Store and culture aware**: Content resolution is scoped by `StoreId`, `CultureName`, and optionally `UserId` / `OrganizationId`.\n- **Search-based access**: Pages and content are retrieved from search indexes (e.g., `GetPageDocumentsQuery`) for performance.\n- **Extensibility**: Module can be extended with custom GraphQL types, fields, and resolvers.\n\n### Core Principles\n\n- **API-first**: Designed as an xAPI wrapper for CMS capabilities.\n- **Performance-oriented**: Uses search indexes and paging (`Skip` / `Take`) for scalable content delivery.\n- **Multi-tenant and multi-language**: Respects Virto Commerce store and language configuration.\n- **Non-intrusive**: Does not replace core CMS modules, but augments them with Experience API endpoints.\n\n## Key Features\n\n### Content Delivery\n\n- **Page documents**: Retrieve page documents from the search index for the current date and context.\n- **Dynamic content**: Deliver CMS content personalized by user, organization, store, and culture.\n- **Routing support**: Resolve pages and content based on requested URLs and store configuration.\n- **Search and filtering**: Filter pages by keyword, culture, and other contextual attributes.\n\n## Documentation\n\n- [xCMS module documentation](https://docs.virtocommerce.org/platform/developer-guide/GraphQL-Storefront-API-Reference-xAPI/Content/overview/)\n- [Experience API Documentation](https://docs.virtocommerce.org/platform/developer-guide/GraphQL-Storefront-API-Reference-xAPI/)\n- [Getting started](https://docs.virtocommerce.org/platform/developer-guide/GraphQL-Storefront-API-Reference-xAPI/getting-started/)\n- [How to use GraphiQL](https://docs.virtocommerce.org/platform/developer-guide/GraphQL-Storefront-API-Reference-xAPI/graphiql/)\n- [How to use Postman](https://docs.virtocommerce.org/platform/developer-guide/GraphQL-Storefront-API-Reference-xAPI/postman/)\n- [How to extend](https://docs.virtocommerce.org/platform/developer-guide/GraphQL-Storefront-API-Reference-xAPI/x-api-extensions/)\n- [Virto Commerce Frontend architecture](https://docs.virtocommerce.org/storefront/developer-guide/architecture/)\n- [View on GitHub](https://github.com/VirtoCommerce/vc-module-x-cms)\n\n## References\n\n- [Deployment](https://docs.virtocommerce.org/platform/developer-guide/Tutorials-and-How-tos/Tutorials/deploy-module-from-source-code/)\n- [Installation](https://docs.virtocommerce.org/platform/user-guide/modules-installation/)\n- [Home](https://virtocommerce.com)\n- [Community](https://www.virtocommerce.org)\n- [Download latest release](https://github.com/VirtoCommerce/vc-module-x-cms/releases/latest)\n\n## License\n\nCopyright (c) Virto Solutions LTD. All rights reserved.\n\nLicensed under the Virto Commerce Open Software License (the \"License\"); you\nmay not use this file except in compliance with the License. You may\nobtain a copy of the License at http://virtocommerce.com/opensourcelicense\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\nimplied.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtocommerce%2Fvc-module-x-cms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvirtocommerce%2Fvc-module-x-cms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtocommerce%2Fvc-module-x-cms/lists"}