h5banner

A CLI (NPM) tool to ease the repetitiveness that comes with coding HTML5 banner ads. Animate one banner with Greensock's animation library, resize it, preview it, package it, done. H5banner lets you focus on the animation.

Usage no npm install needed!

<script type="module">
  import h5banner from 'https://cdn.skypack.dev/h5banner';
</script>

README

H5banner

A CLI (NPM) tool to ease the repetitiveness that comes with coding HTML5 banner ads. Animate one banner with Greensock's animation library, resize it, preview it, package it, done. H5banner lets you focus on the animation.

Once you've animated your first banner, you can run resize and then easily tweak that animation for each size, giving you full control over each size.

After that, it's often necessary to send the banners for review to a client or within an agency, that's what the preview command is for. Just drag and drop the preview folder on a publicly accessible server and it's ready for sharing.

Once you're ready to package the banners, just run the handoff command. This command grabs all related images and global css/js assets for each banner. Then makes a version of the banner for each vendor, and zips it up. Then all banners are zipped into one nice packaged file.

Development Experience

H5banner is all about making the development experience of HTML5 banner animation easier and more pleasant. As such, there is a centralized view where you can ajax load each banner with a timeline scrubber. This view is loaded with Browser Sync after both of the h5banner one, h5banner resize, and h5banner watch commands.

Commands:

  • init – Builds H5banner project directory structure and config.
  • one – Generates first banner from template.
  • resize – Resize your first banner into all remaining sizes selected during configuration. These can also be found in your h5banner-conf.json file.
  • watch - Run a BrowserSync server to watch the banners and launch the generated index.html
  • preview - Generate a drag n' drop preview webpage to showcase the banners.
  • handoff - Zip/Package/Compress the Banner-Ads for ad-network delivery.

Options:

  • -h, --help output usage information
  • -V, --version output the version number

Asset naming conventions

Layers for HTML5 Banners

These are images that you'll use within the HTML5 banners. Be sure that each banner has it's own images. Even if banners use the same image, each banner will need their own. Place all of these images in assets/images/ during development. These will be copied into each individual banner directory when you run the handoff command.

Static backups

These are often used by vendors as statics when HTML5 banners aren't able to load in a visitors browser. To work an H5banner, you'll want to put them within the assets/statics/ dir, and name them as follows: size.extension (Example: 300x600.png).

Generated Project Structure

  • ani-conf.json
  • README.md
  • .gitignore
  • assets
    • statics
      • (size.jpg)
      • (size.png) ...
    • images
      • (size)
        • (layer.jpg)
        • (layer.png) ...
  • banners
    • (size.html) ...