{"id":26289970,"url":"https://github.com/slack-samples/bolt-js-assistant-template","last_synced_at":"2025-05-07T22:43:54.640Z","repository":{"id":258701304,"uuid":"852489834","full_name":"slack-samples/bolt-js-assistant-template","owner":"slack-samples","description":"A template for building Agents \u0026 Assistants with Bolt for JavaScript","archived":false,"fork":false,"pushed_at":"2025-05-01T17:39:14.000Z","size":314,"stargazers_count":10,"open_issues_count":3,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-01T18:38:41.572Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slack-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-04T22:33:48.000Z","updated_at":"2025-05-01T17:38:08.000Z","dependencies_parsed_at":"2024-11-20T02:32:08.475Z","dependency_job_id":"3d8eef8a-f60c-430a-b521-1d6154303383","html_url":"https://github.com/slack-samples/bolt-js-assistant-template","commit_stats":null,"previous_names":["slack-samples/bolt-js-assistant-template"],"tags_count":0,"template":true,"template_full_name":"slack-samples/bolt-js-starter-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-js-assistant-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-js-assistant-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-js-assistant-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-js-assistant-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slack-samples","download_url":"https://codeload.github.com/slack-samples/bolt-js-assistant-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252967974,"owners_count":21833245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-14T23:17:31.749Z","updated_at":"2025-05-07T22:43:54.631Z","avatar_url":"https://github.com/slack-samples.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# App Agent \u0026 Assistant Template (Bolt for JavaScript)\n\nThis Bolt for JavaScript template demonstrates how to build [Agents \u0026 Assistants](https://api.slack.com/docs/apps/ai) in Slack.\n\nModels from the [Hugging Face](https://huggingface.co) platform are used and can be customized for prompts of all kinds.\n\n## Setup\n\nBefore getting started, make sure you have a development workspace where you have permissions to install apps. If you don’t have one setup, go ahead and [create one](https://slack.com/create).\n\n### Developer Program\n\nJoin the [Slack Developer Program](https://api.slack.com/developer-program) for exclusive access to sandbox environments for building and testing your apps, tooling, and resources created to help you build and grow.\n\n## Installation\n\n### Create a Slack App\n\n1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and\n   choose \"From an app manifest\"\n2. Choose the workspace you want to install the application to\n3. Copy the contents of [manifest.json](./manifest.json) into the text box that\n   says `*Paste your manifest code here*` (within the JSON tab) and click _Next_\n4. Review the configuration and click _Create_\n5. You'll then be redirected to App Settings. Visit the **Install App** page and install your app.\n\n### Environment Variables\n\nBefore you can run the app, you'll need to store some environment variables.\n\n1. Rename `.env.sample` to `.env`\n2. Open your apps setting page from\n   [this list](https://api.slack.com/apps), click _OAuth \u0026 Permissions_ in the\n   left hand menu, then copy the _Bot User OAuth Token_ into your `.env` file\n   under `SLACK_BOT_TOKEN`\n3. Click _Basic Information_ from the left hand menu and follow the steps in the\n   _App-Level Tokens_ section to create an app-level token with the\n   `connections:write` scope. Copy that token into your `.env` as\n   `SLACK_APP_TOKEN`.\n\nA fine grained [access token](https://huggingface.co/settings/tokens) with the \"Make calls to Inference Providers\" permission from Hugging Face is also needed. Store this as `HUGGINGFACE_API_KEY`.\n\n### Local Project\n\n```zsh\n# Clone this project onto your machine\ngit clone https://github.com/slack-samples/bolt-js-assistant-template.git\n\n# Change into this project directory\ncd bolt-js-assistant-template\n\n# Install dependencies\nnpm install\n\n# Run Bolt server\nnpm start\n```\n\n### Linting\n\n```zsh\n# Run lint for code formatting and linting\nnpm run lint\n```\n\n## Project Structure\n\n### `manifest.json`\n\n`manifest.json` is a configuration for Slack apps. With a manifest, you can create an app with a pre-defined configuration, or adjust the configuration of an existing app.\n\n### `app.js`\n\n`app.js` is the entry point for the application and is the file you'll run to start the server. This project aims to keep this file as thin as possible, primarily using it as a way to route inbound requests.\n\n## App Distribution / OAuth\n\nOnly implement OAuth if you plan to distribute your application across multiple workspaces. A separate `app-oauth.js` file can be found with relevant OAuth settings.\n\nWhen using OAuth, Slack requires a public URL where it can send requests. In this template app, we've used [`ngrok`](https://ngrok.com/download). Checkout [this guide](https://ngrok.com/docs#getting-started-expose) for setting it up.\n\nStart `ngrok` to access the app on an external network and create a redirect URL for OAuth.\n\n```\nngrok http 3000\n```\n\nThis output should include a forwarding address for `http` and `https` (we'll use `https`). It should look something like the following:\n\n```\nForwarding   https://3cb89939.ngrok.io -\u003e http://localhost:3000\n```\n\nNavigate to **OAuth \u0026 Permissions** in your app configuration and click **Add a Redirect URL**. The redirect URL should be set to your `ngrok` forwarding address with the `slack/oauth_redirect` path appended. For example:\n\n```\nhttps://3cb89939.ngrok.io/slack/oauth_redirect\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-js-assistant-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fbolt-js-assistant-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-js-assistant-template/lists"}