@orbit-love/producthunt

0.3.1 • Public • Published

Product Hunt to Orbit Workspace

Build Status npm version Contributor Covenant

This is a JavaScript package that can be used to integrate new Product Hunt votes and comments into your organization's Orbit workspace.

This is a community project. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.

We welcome community contributions to make sure that it stays current.

There are three ways to use this integration. Install package - build and run your own applications. Run the CLI - run on-demand directly from your terminal. Schedule an automation with GitHub - get started in minutes - no coding required

First Time Setup

  1. Create a new Product Hunt API Application
    1. Redirect URI can be any web address
    2. Take note of your API Key and API Secret

Application Credentials

The application requires the following environment variables:

Variable Description More Info
PRODUCT_HUNT_API_KEY API Key for your Product Hunt Application Follow the guide above
PRODUCT_HUNT_API_SECRET API Secret for your Product Hunt Application Follow the guide above
ORBIT_API_KEY API key for Orbit Found in Account Settings in your Orbit workspace
ORBIT_WORKSPACE_ID ID for your Orbit workspace Last part of the Orbit workspace URL, i.e. https://app.orbit.love/my-workspace, the ID is my-workspace

Package Usage

Install the package with the following command

$ npm install @orbit-love/producthunt

The standard initialization of the library requires the following signature:

const OrbitProductHunt = require('@orbit-love/producthunt')
const orbitProductHunt = new OrbitProductHunt('orbitWorkspaceId', 'orbitApiKey', 'productHuntApiKey', 'productHuntApiSecret')

If you have the following environment variables set: ORBIT_WORKSPACE_ID, ORBIT_API_KEY, PRODUCT_HUNT_API_KEY, and PRODUCT_HUNT_API_SECRET then you can initialize the client as follows:

const OrbitProductHunt = require('@orbit-love/producthunt')
const orbitProductHunt = new OrbitProductHunt()

Get Product IDs Made By A User

const products = await orbitProductHunt.getProducts('_phzn')
console.log(products)

Add New Votes On Product

const votes = await orbitProductHunt.getVotes(productId)
const prepared = await orbitProductHunt.prepareVotes(votes, 24) // 24 is the number of previous hours to get votes from
const outcome = await orbitProductHunt.addActivities(prepared)
console.log(outcome)

Add New Comments On Product

const votes = await orbitProductHunt.getComments(productId)
const prepared = await orbitProductHunt.prepareComments(votes, 24) // 24 is the number of previous hours to get votes from
const outcome = await orbitProductHunt.addActivities(prepared)
console.log(outcome)

CLI Usage

To use this package you do not need to install it, but will need Node.js installed on your machine.

npx @orbit-love/producthunt --products --user=username

# Add new votes or comments
npx @orbit-love/producthunt --votes --id=projectid
npx @orbit-love/producthunt --comments --id=projectid

# Add new votes and comments
npx @orbit-love/producthunt --votes --comments --id=projectid

By default this will get the last 1 hours worth of votes, but this can be explicitly overridden:

npx @orbit-love/producthunt --votes --id=projectid --hours=12

GitHub Actions Automation Setup

You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.

See our guide for setting up this automation

Contributing

We 💜 contributions from everyone! Check out the Contributing Guidelines for more information.

License

This project is under the MIT License.

Code of Conduct

This project uses the Contributor Code of Conduct. We ask everyone to please adhere by its guidelines.

Package Sidebar

Install

npm i @orbit-love/producthunt

Weekly Downloads

844

Version

0.3.1

License

MIT

Unpacked Size

180 kB

Total Files

14

Last publish

Collaborators

  • steeve-orbit
  • mxdavis
  • colinloretz
  • dzello