https://github.com/newamericafoundation/na-cli

a CLI scaffolding tool to quickly create new data viz projects
https://github.com/newamericafoundation/na-cli

Last synced: 12 days ago
JSON representation

a CLI scaffolding tool to quickly create new data viz projects

• Host: GitHub
• URL: https://github.com/newamericafoundation/na-cli
• Owner: newamericafoundation
• Created: 2018-11-30T21:27:22.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-08-06T23:19:37.000Z (over 5 years ago)
• Last Synced: 2025-01-09T12:03:44.339Z (23 days ago)
• Language: JavaScript
• Size: 64.5 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# New America's Data Viz Project Generator

### What it does

- Creates a new repo in the newamerica-graphics Github organization with your project name

- Clones the [data viz boilerplate](https://github.com/newamerica-graphics/data-viz-boilerplate) into a local folder

- Changes the remote of the local repo to the new repo in newamerica-graphics

- Replaces the project name in the `package.json` file

- Pushes the code to the new remote

- Installs local dependencies

### Installation

Things you need:

- git and node

- write access to the newamerica-graphics organization

Use with [npx](https://www.npmjs.com/package/npx) is recommended so that you don't have install anything globally or worry about keeping it up to date. But if you really want to install the package, you can use `npm install -g @newamerica/na-cli`.

### Usage

```

Usage: na-cli [command] [options]

Commands:

  setup             Scaffold a new data viz project with specified slug

Options:

  -d, --directory         an optional directory, defaults to current directory if omitted

  -v, --version           output the version number

  -h, --help              output usage information

```

### Example usage with npx

Note: npx does not require you to install the package.

```

npx @newamerica/na-cli na-cli setup nann_network_research -d ~/code

```