Socket
Socket
Sign inDemoInstall

dc-accelerators-content-rendering-service

Package Overview
Dependencies
1
Maintainers
6
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

dc-accelerators-content-rendering-service

Amplience DC Frontend modules, using HTML Service


Version published
Maintainers
6
Weekly downloads
154
decreased by-24.51%

Weekly downloads

Readme

Source

Amplience Dynamic Content

Dynamic Content Accelerators - Rendering Service

Extensible content types and rendering templates for use with the Amplience Rendering Service

github version License

This 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.

Amplience Dynamic Content Accelerators

Demo

Getting started

Developing components

This project has a local development environment which lets you test your component templates, styles and javascript without deploying them to Dynamic Content.

Steps:

  1. Check-out the project
  2. Install project dependencies
npm install
  1. Run development environment
npm run storybook

This will launch a browser displaying the components using Storybook, a popular component explorer. Any changes made to template files, styles or Javascript will reload automatically.

See the documentation links below for further details.

Exporting components

Before you can deploy the components you need to run the export process. This will compile, concatenate and minify the CSS & JavaScript as well as collect the templates, icons and content types into a folder to ease deployment.

Steps:

  1. Ensure gulp-cli is installed:
npm install --global gulp-cli
  1. Run gulp:
gulp

This will export the following files:

filedescription
dist/contentTypesContent Types which define the content structure for each component.
dist/templatesContent Rendering Service templates which render content to HTML.
dist/iconsIcons for each component.
dist/styles.min.cssCSS Styles for the components.
dist/utils.min.jsJavaScript which adds functionality to the components.
dist/lory.min.jsJavaScript Library required by the Slider component.

Deploying components

To make use of these components in your application you must configure them in your Amplience account in addition to including the CSS & JavaScript in your project.

Configure Dynamic Content

To make the components available for use they must be configured in your Dynamic Content account. This includes:

Steps for this can be found in the configuration guide.

Include CSS & JavaScript

Include a reference to the CSS & JavaScript resources in your application.

<link rel="stylesheet" href="dist/styles.min.css"/>
<script src="dist/utils.js"></script>

If you are using the Slider component also include the lory library.

<script src="dist/lory.min.js"></script>

Interactive 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:

if (window.AmpCa && window.AmpCa.Utils) {
   window.AmpCa.Utils.attachComponents();
}

Documentation

Getting Help

If you need help please reach out using one of the following channels:

License

This software is licensed under the Apache License, Version 2.0,

Copyright 2019 Amplience

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Keywords

FAQs

Last updated on 12 Feb 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc