npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dc-accelerators-content-rendering-service

v4.0.1

Published

Amplience DC Frontend modules, using HTML Service

Downloads

833

Readme

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:

| file | description | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | dist/contentTypes | Content Types which define the content structure for each component. | | dist/templates | Content Rendering Service templates which render content to HTML. | | dist/icons | Icons for each component. | | dist/styles.min.css | CSS Styles for the components. | | dist/utils.min.js | JavaScript which adds functionality to the components. | | dist/lory.min.js | JavaScript 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.