@politico/interactive-bin

@politico/interactive-bin

JS Utilities used in the creation and distribution of interactive news at POLITICO.

Quick Start

Installation:

$ npm install -g @politico/interactive-bin

One-Time Setup (if you work at POLITICO, check out the POLITICO Onboarding Guide):

$ pib setup

Then you can use its commands by running:

$ pib <command> <...arguments>

Starting a New Interactive

To start a new interactive, make an empty directory.

$ mkdir MY_INTERACTIVE_NAME
$ cd MY_INTERACTIVE_NAME

Then run the new project command:

$ pib new project

Using the CLI

Once you have pib installed you can access the CLI's many commands. Check out those docs for more on what they are and how to use them.

Using PIB In Interactives

For the most part, the PIB CLI should only be used to create new projects. Once inside a PIB-made interactive you should switch to using the yarn commands that come with those PIB projects. This will ensure that all the files and folder paths are processed correctly.

For example,

✅ yarn api new ✅ yarn new page ✅ yarn pub

❌ pib api new ❌ pib new page ❌ pib publish

PIB has some (many) opinions on how to structure your projects. These are somewhat enforced with your starting template, but you can check out the projects docs for more.