{"id":21511355,"url":"https://github.com/amplience/dc-accelerators-content-rendering-service","last_synced_at":"2025-08-22T13:38:16.020Z","repository":{"id":33829351,"uuid":"144865970","full_name":"amplience/dc-accelerators-content-rendering-service","owner":"amplience","description":"An accelerated starting point for implementing Amplience Dynamic Content.","archived":false,"fork":false,"pushed_at":"2023-07-17T10:26:42.000Z","size":7429,"stargazers_count":15,"open_issues_count":35,"forks_count":15,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-09T18:06:17.235Z","etag":null,"topics":["es6","front-end","handlebars","html","javascript","npm","vanilla-javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/amplience.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.MD","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":"2018-08-15T14:48:36.000Z","updated_at":"2023-07-17T10:26:49.000Z","dependencies_parsed_at":"2024-06-19T14:33:42.774Z","dependency_job_id":"8fbb7aed-974b-4e2d-9972-e58852529118","html_url":"https://github.com/amplience/dc-accelerators-content-rendering-service","commit_stats":{"total_commits":115,"total_committers":8,"mean_commits":14.375,"dds":0.5304347826086957,"last_synced_commit":"4d5fef2f5019395ffe7eb1c6e39a6ed88b47013e"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amplience%2Fdc-accelerators-content-rendering-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amplience%2Fdc-accelerators-content-rendering-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amplience%2Fdc-accelerators-content-rendering-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amplience%2Fdc-accelerators-content-rendering-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amplience","download_url":"https://codeload.github.com/amplience/dc-accelerators-content-rendering-service/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amplience%2Fdc-accelerators-content-rendering-service/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259219376,"owners_count":22823569,"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":["es6","front-end","handlebars","html","javascript","npm","vanilla-javascript"],"created_at":"2024-11-23T22:06:50.362Z","updated_at":"2025-06-11T07:09:16.653Z","avatar_url":"https://github.com/amplience.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dynamic Content Accelerators - Rendering Service\n\n\u003e Extensible content types and rendering templates for use with the Amplience Rendering Service\n\n[![github version](https://img.shields.io/github/release/amplience/dc-accelerators-content-rendering-service.svg)](https://github.com/amplience/dc-accelerators-content-rendering-service/releases/latest) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nThis project is designed to accelerate implementing Amplience Dynamic Content. It contains a set of commonly used components implemented as handlebars templates that can be rendered by the [Content Rendering Service](https://docs.amplience.net/integration/contentrenderingservice.html#the-content-rendering-service).\n\n[![Amplience Dynamic Content Accelerators](media/screenshot.jpeg)](https://amplience.com/dynamic-content)\n\n## Demo\n\n* [Working demo](https://dev-solutions.s3.amazonaws.com/dc-demo-site/dist/homepage/index.html?c=d8b929ee-214d-48f0-90c0-4e121ca55a6f\u0026s=e6bdb253-db3c-4458-b5cc-0d90aa02e114) of the accelerator components.\n\n* [Component explorer](http://dev-solutions.s3.amazonaws.com/dc-renders-wireframe/dist/index.html?c=ab78c8be-9f03-4a52-bde0-4ebde03b79a3) showcasing the capability of each component.\n\n## Getting started\n\n### Developing components\n\nThis project has a local development environment which lets you test your component templates, styles and javascript without deploying them to Dynamic Content.\n\nSteps:\n\n1. Check-out the project\n2. Install project dependencies\n```js\nnpm install\n```\n3. Run development environment\n```js\nnpm run storybook\n```\n\nThis will launch a browser displaying the components using [Storybook](https://storybook.js.org/), a popular component explorer. Any changes made to template files, styles or Javascript will reload automatically.\n\nSee the [documentation](#documentation) links below for further details.\n\n### Exporting components\n\nBefore you can deploy the components you need to run the export process. This will compile, concatenate and minify the CSS \u0026 JavaScript as well as collect the templates, icons and content types into a folder to ease deployment.\n\nSteps:\n\n1. Ensure gulp-cli is installed:\n```\nnpm install --global gulp-cli\n```\n\n2. Run gulp:\n\n```\ngulp\n```\n\nThis will export the following files:\n\n| file                | description                                                                                                                                                            |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| dist/contentTypes   | [Content Types](https://docs.amplience.net/integration/contenttypes.html) which define the content structure for each component.                                        |\n| dist/templates      | [Content Rendering Service](https://docs.amplience.net/integration/contentrenderingservice.html#the-content-rendering-service) templates which render content to HTML. |\n| dist/icons          | Icons for each component.                                                                                                                                              |\n| dist/styles.min.css | CSS Styles for the components.                                                                                                                                         |\n| dist/utils.min.js   | JavaScript which adds functionality to the components.                                                                                                                 |\n| dist/lory.min.js    | [JavaScript Library](https://github.com/loryjs/lory) required by the Slider component.                                                                                 |\n\n### Deploying components\n\nTo make use of these components in your application you must configure them in your Amplience account in addition to including the CSS \u0026 JavaScript in your project.\n\n#### Configure Dynamic Content\n\nTo make the components available for use they must be configured in your Dynamic Content account. This includes:\n\n* [Content Types](https://docs.amplience.net/integration/contenttypes.html)\n* [Content Rendering Templates](https://docs.amplience.net/integration/contentrenderingservice.html)\n* [Image Transformation Templates](https://docs.amplience.net/contenthub/tools.html#templates)\n\nSteps for this can be found in the [configuration guide](./docs/CONFIGURE-DYNAMIC-CONTENT.md).\n\n#### Include CSS \u0026 JavaScript\n\nInclude a reference to the CSS \u0026 JavaScript resources in your application.\n\n```html\n\u003clink rel=\"stylesheet\" href=\"dist/styles.min.css\"/\u003e\n\u003cscript src=\"dist/utils.js\"\u003e\u003c/script\u003e\n```\n\nIf you are using the Slider component also include the [lory library](https://github.com/loryjs/lory).\n\n```html\n\u003cscript src=\"dist/lory.min.js\"\u003e\u003c/script\u003e\n```\n\nInteractive components will automatically attach their functionality when the DOM has loaded. If your application asynchronously renders the components you can manually activate the components with the following JavaScript:\n\n```js\nif (window.AmpCa \u0026\u0026 window.AmpCa.Utils) {\n   window.AmpCa.Utils.attachComponents();\n}\n```\n\n## Documentation\n\n* [Creating new components](./docs/CREATING-COMPONENTS.md)\n* [Extending Storybook](./docs/EXTENDING-STORYBOOK.md)\n* [Template dependencies](./docs/TEMPLATE-DEPENDENCIES.md)\n* [Hosting Content Types externally](./docs/EXTERNAL-CONTENT-TYPES.md)\n\n## Getting Help\nIf you need help please reach out using one of the following channels:\n\n* Ask a question on [StackOverflow](https://stackoverflow.com/) using the tag `amplience-dynamic-content`\n* Contact your [Amplience Customer Success](https://amplience.com/customer-success) representative\n* If you have found a bug please report it by [opening an issue](https://github.com/amplience/dc-accelerators-content-rendering-service/issues/new)\n\n## License\n\nThis software is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\n\nCopyright 2019 Amplience\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\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 implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famplience%2Fdc-accelerators-content-rendering-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famplience%2Fdc-accelerators-content-rendering-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famplience%2Fdc-accelerators-content-rendering-service/lists"}