Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 1.95 KB

README.md

File metadata and controls

87 lines (62 loc) · 1.95 KB

Growth Tools

Growth Tools is a collection of scripts that can be used to launch scrappy growth experiments.

Required Tools

Install:

Install NodeJS with nvm:

nvm install node

Optional: install yarn for package management.

npm install -g yarn

Install

Checkout the source code and in the root directory run:

npm install

# OR use yarn (we prefer yarn at SVRF)
yarn install

Make the exports directory where the exported files will be saved:

mkdir ./exports

API Keys

The Growth Tool scripts require API keys from the following platforms:

You may want to put these secrets in your .bash_profile or another appropriate source executable so you don't always have to set them, eg:

export PRODUCT_HUNT_CLIENT_ID=<Insert Client Id>
export PRODUCT_HUNT_CLIENT_SECRET=<Insert Client Secret>

export FULLCONTACT_API_KEY=<Insert API Key>

export TWITTER_API_KEY=<Insert API Key>
export TWITTER_API_SECRET=<Insert API Secret>
export TWITTER_ACCESS_TOKEN=<Insert Access Token>
export TWITTER_ACCESS_TOKEN_SECRET=<Insert Access Token Secret>

.bash_profile help

Here's just a few commands to help you if you don't really know what you're doing, but I'd strongly suggest you Google anything you don't know.

# Create your .bash_profile
touch ~/.bash_profile

# Open and edit your .bash_profile
open ~/.bash_profile

# Reload your edited .bash_profile
source ~/.bash_profile

Running

To use the scripts, in the root directory, run something like this:

node . <command> <options>

If you need help you can enter:

# Get a list of available commands
node . --help

# Get help for a specific command
node . <command> --help

Results will export to a file in the ./exports directory.