@zanichelli/zanichelli-adv
v1.5.1
Published
Zanichelli Advertising Component
Downloads
20
Maintainers
Keywords
Readme
Zanichelli Advertising Component
Deploy of the application
This application is currently deployed using Google Tag Manager. Every third party application which includes Zanichelli GTM script, will have the zanichelli-adv component in their html body. The configuration file hosted on AWS S3 will decide about the component rendering.
The file script-deploy.js is used inside the tag fired by GTM container.
Release Procedure
Production
To deliver a production release, please use the appropriate package.json script release:prod that will generate a latest version.
Test
To deliver a version for testing purpose, please use the appropriate package.json script release:test that will generate a version tagged as test.
It is really important to use latest tag only for production, because every release tagged as latest will end up in production directly, given the GTM deploy method explained above. If you need to create a release that is nor for production neither for test, please use release:tag package.json script. You will be asked for a tag to choose.
Using this component locally
You may override the values defined inside .env
by creating a .env.local
file with the variables you need.
To install and run the application in development mode:
yarn
yarn start
To build the component run:
yarn build
- add in your own file /etc/hosts
127.0.0.1 adv.zanichelli.it
advertising is displayed based on the config.json
configuration uploaded to a zanichelli-adv-staging
S3 bucket. if the host is present in the configuration, advertising will be displayed.
If you want to develop with a local config file, please copy config.example.json to www folder AFTER yarn start command.
example config:
{
"hosts": ["adv.zanichelli.it:3333"]
}
Installation (if you still need)
Download the package running this command:
yarn add @zanichelli/zanichelli-adv
or import it in your html using Unpkg:
<script type="module" src="https://cdn.jsdelivr.net/npm/@zanichelli/zanichelli-adv/dist/zanichelli-adv/zanichelli-adv.esm.js"></script>
Albe Web Components dependency
This component requires the Albe Web Components Library. To get Albe you can:
- install it via NPM by running
yarn add @zanichelli/albe-web-components
- include it in your app inside a
script
tag:
<script type="module" src="https://cdn.jsdelivr.net/npm/@zanichelli/albe-web-components/dist/web-components-library/web-components-library.esm.js"></script>
Remember to also include the stylesheet:
<link type="text/css" rel="stylesheet" href="https://unpkg.com/@zanichelli/albe-web-components/www/build/web-components-library.css" />
The dates in the adv modal are in this format:
(DD/MM/YYYY)