Package Exports

@orbit-love/reddit

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@orbit-love/reddit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Reddit to Orbit Workspace

This is a JavaScript package that can be used to integrate new Reddit interactions from a specified subreddit 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

Head to your Reddit App Preferences.
Create a new app with the following settings:
1. Name: orbit-community-integration
2. Type: script
3. Description: orbit.love community integration
4. About URL: https://github.com/orbit-love/community-js-reddit-orbit
5. Redirect URI: https://orbit.love
Take note of your Client ID which is just below your app name, and your Client Secret.

Application Credentials

The application requires the following environment variables:

Variable	Description	More Info
`REDDIT_CLIENT_ID`	Client ID for your Reddit App	Follow the guide above
`REDDIT_CLIENT_SECRET`	Client Secret for your Reddit App	Follow the guide above
`REDDIT_USERNAME`	Your Reddit username	Your account credentials
`REDDIT_PASSWORD`	Your Reddit password	Your account credentials
`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/reddit

The standard initialization of the library requires the following signature:

const OrbitReddit = require('@orbit-love/reddit')
const orbitReddit = new OrbitReddit('orbitWorkspaceId', 'orbitApiKey', 'redditClientId', 'redditClientSecret', 'redditUsername', 'redditPassword')

If you have the following environment variables set: ORBIT_WORKSPACE_ID, ORBIT_API_KEY, REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET, REDDIT_USERNAME and REDDIT_PASSWORD then you can initialize the client as follows:

const OrbitReddit = require('@orbit-love/reddit')
const orbitReddit = new OrbitReddit()

Add New Posts In Subreddit

const OrbitReddit = require('@orbit-love/reddit')
const orbitReddit = new OrbitReddit()

// Allows you to go back a number of hours and only get posts in that timeframe
const posts = await orbitReddit.getPosts({ subreddit: 'javascript', hours: 24 })
const prepared = await orbitReddit.preparePosts(posts)
const added = await orbitReddit.addActivities(prepared)
console.log(added) // "Added n activities to your Orbit workspace"

Add New Comments In Subreddit

const OrbitReddit = require('@orbit-love/reddit')
const orbitReddit = new OrbitReddit()

// Allows you to go back a number of hours and only get posts in that timeframe
const comments = await orbitReddit.getComments({ subreddit: 'javascript', hours: 24 })
const prepared = await orbitReddit.prepareComments(comments)
const added = await orbitReddit.addActivities(prepared)
console.log(added) // "Added n activities to your Orbit workspace"

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/reddit --posts --subreddit=javascript
npx @orbit-love/reddit --comments --subreddit=javascript

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

npx @orbit-love/reddit --posts --subreddit=javascript --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.