:sparkles:
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.:sparkles:
|\n|-----------------------------------------|\n\n\n\n## First Time Setup\n\nTo set up this integration you will need some details from StackOverflow. During the setup, we will need to create a new application on Stack Apps which will allow this integration to interact with the platform. The application will contain a Key which we should take note of for later.\n\n1. Head to [Stack Apps](https://stackapps.com) and login in to your account.\n2. [Register a new Stack Apps application](https://stackapps.com/apps/oauth/register). The oauth domain can be anything, as can the application website.\n3. In your application settings, take note of your `Key` value.\n\n\n## Application Credentials\n\nThe application requires the following environment variables:\n\n| Variable | Description | More Info\n|---|---|--|\n| `STACK_APPS_KEY` | API Key to query Stack Overflow | Follow the First Time Setup guide above\n| `ORBIT_API_KEY` | API key for Orbit | Found in `Account Settings` in your Orbit workspace\n| `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`\n\n## Installation\n\nInstall the package with the following command\n\n```\n$ npm install @orbit-love/stackoverflow\n```\n\nThe standard initialization of the library requires the following signature:\n\n```js\nconst OrbitStackOverflow = require('@orbit-love/stackoverflow')\nconst orbitStackOverflow = new OrbitStackOverflow('orbitWorkspaceId', 'orbitApiKey', 'stackAppsKey')\n```\n\nIf you have the following environment variables set: `ORBIT_WORKSPACE_ID`, `ORBIT_API_KEY`, and `STACK_APPS_KEY` then you can initialize the client as follows:\n\n```js\nconst OrbitStackOverflow = require('@orbit-love/stackoverflow')\nconst orbitStackOverflow = new OrbitStackOverflow()\n```\n\n## Questions\n\n```js\n// Allows you to go back a number of hours and only get questions in that timeframe\nconst questions = await orbitStackOverflow.getQuestions({ tag: 'tag-1', hours: 24 })\nconst prepared = await orbitStackOverflow.prepareQuestions(questions)\nconst summary = await orbitStackOverflow.addActivities(prepared)\nconsole.log(summary)\n```\n\n### `prepareQuestions()`\n\nThere are several options when calling the `prepareQuestions()` method. The default is `'orbitActivity'`.\n\n```js\n// Returns question list as Orbit activity objects\nawait orbitStackOverflow.prepareQuestions(questions, 'orbitActivity')\n\n// Returns questions that have at least one answer\nawait orbitStackOverflow.prepareQuestions(questions, 'hasAnswer')\n\n// Returns questions with recent activity\nawait orbitStackOverflow.prepareQuestions(questions, 'recentActivity', { hours: 24 })\n\n// Returns questions that are new within a number of hours - useful for post-fetching filtering\nawait orbitStackOverflow.prepareQuestions(questions, 'postedWithinHours', { hours: 24 })\n\n// Returns an array of question IDs only\nawait orbitStackOverflow.prepareQuestions(questions, 'onlyIds')\n```\n\n## Answers\n\n```js\nconst questionIds = [123, 456, 789]\nconst answers = await orbitStackOverflow.getAnswers({ ids: questionIds, hours: 24 })\nconst prepared = await orbitStackOverflow.prepareAnswers(questions)\nconst summary = await orbitStackOverflow.addActivities(prepared)\nconsole.log(summary)\n```\n\n## CLI Usage\n\nTo use this package you do not need to install it, but will need Node.js installed on your machine.\n\nTo use the CLI you must have the following environment variables set: `ORBIT_WORKSPACE_ID`, `ORBIT_API_KEY`, and `STACK_APPS_KEY`.\n\n```\nnpx @orbit-love/stackoverflow [FLAGS]\n```\n\n### Questions\n\n```\nnpx @orbit-love/stackoverflow --questions --tag=tag-1 [--hours=12]\n```\n\n* `--hours` is optional and defaults to 24.\n\n### Answers\n\n```\nnpx @orbit-love/stackoverflow --answers --tag=tag-1 [--hours=12]\n```\n\n* `--hours` is optional and defaults to 24.\n* This will only get answers on questions posted in the last 28 days.\n\n### Questions & Answers\n\n```\nnpx @orbit-love/stackoverflow --questions --answers --tag=tag-1 [--hours=12]\n```\n\n* `--hours` is optional and defaults to 24.\n* This will only get answers on questions posted in the last 28 days.\n\n## GitHub Actions Automation Setup\n\nā” 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.\n\n[See our guide for setting up this automation](https://github.com/orbit-love/github-actions-templates/blob/main/StackOverflow/README.md).\n\n## Contributing\n\nWe š contributions from everyone! Check out the [Contributing Guidelines](.github/CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is under the [MIT License](./LICENSE).\n\n## Code of Conduct\n\nThis project uses the [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.\n","readmeFilename":"README.md"}