viewport-tools

Deprecation Notice

This module will be deprecated for its alternative viewport-uploader. Copy and follow the instructions of the basic example of this new module to get started with Viewport Theme Development. It uses webpack for bundling which allows you to use ES6 style javascript in your custom theme. viewport-tools won't receive any more updates in the future.

The viewport-tools contain command-line tools for Scroll Viewport theme developers.

---

Installation

Being command-line the viewport-tools should be installed globally.

$ npm install -g viewport-tools

If that doesn't work, try $ sudo npm install -g viewport-tools.

Usage

Initialize local development

Set up ~/.viewportrc to develop locally with the gulp-viewport plugin:

$ viewport init

Create a new Scroll Viewport Theme

Create a new Scroll Viewport theme project:

$ viewport create

NOTE: Make sure to follow the getting started steps provided when the theme has been created.

Development

1. Checkout project
2. Do npm link

Resources

• Tim Pettersen: Building command line tools with Node.js, URL: https://developer.atlassian.com/blog/2015/11/scripting-with-node/
• The npm Blog: Building a simple command line tool with npm, URL: http://blog.npmjs.org/post/118810260230/building-a-simple-command-line-tool-with-npm

License

MIT