{"id":26289955,"url":"https://github.com/slack-samples/bolt-ts-custom-function-template","last_synced_at":"2025-03-14T23:17:28.363Z","repository":{"id":253160567,"uuid":"842580688","full_name":"slack-samples/bolt-ts-custom-function-template","owner":"slack-samples","description":"A template for building automations with Bolt for JavaScript (TypeScript)","archived":false,"fork":false,"pushed_at":"2025-03-05T19:04:48.000Z","size":220,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-05T20:19:49.257Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-14T16:32:13.000Z","updated_at":"2025-03-05T19:04:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"4d13f62e-6531-464d-b548-52237e0823ac","html_url":"https://github.com/slack-samples/bolt-ts-custom-function-template","commit_stats":null,"previous_names":["slack-samples/bolt-ts-custom-function-template"],"tags_count":0,"template":true,"template_full_name":"slack-samples/bolt-ts-starter-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-ts-custom-function-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-ts-custom-function-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-ts-custom-function-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-ts-custom-function-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slack-samples","download_url":"https://codeload.github.com/slack-samples/bolt-ts-custom-function-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243658257,"owners_count":20326467,"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:27.785Z","updated_at":"2025-03-14T23:17:28.350Z","avatar_url":"https://github.com/slack-samples.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bolt for JavaScript (TypeScript) Custom Function Template\n\nThis is a Bolt for JavaScript (TypeScript) template app used to build custom functions for\nuse in [Workflow Builder](https://api.slack.com/start#workflow-builder).\n\n## Setup\n\nBefore getting started, first make sure you have a development workspace where\nyou have permission to install apps. **Please note that the features in this\nproject require that the workspace be part of\n[a Slack paid plan](https://slack.com/pricing).**\n\n### Developer Program\n\nJoin the [Slack Developer Program](https://api.slack.com/developer-program) for\nexclusive access to sandbox environments for building and testing your apps,\ntooling, and resources created to help developers 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. Click _Install_ button and _Allow_ on the screen that follows. You'll then be\n   redirected to the App Settings dashboard.\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\n### Local Project\n\n```zsh\n# Clone this project onto your machine\ngit clone https://github.com/slack-samples/bolt-ts-custom-function-template.git\n\n# Change into this project directory\ncd bolt-ts-custom-function-template\n\n# Install dependencies\nnpm install\n\n# Run Bolt server\nnpm start\n```\n\n### Testing\n\nRun the TypeScript compilation, code formatting and linting:\n\n```zsh\nnpm test\n```\n\n## Using Steps in Workflow Builder\n\nWith your server running, your function is now ready for use in\n[Workflow Builder](https://api.slack.com/start#workflow-builder)! Add it as a\ncustom step in a new or existing workflow, then run the workflow while your app\nis running.\n\nFor more information on creating workflows and adding custom steps, read more\n[here](https://slack.com/help/articles/17542172840595-Create-a-new-workflow-in-Slack).\n\n## Project Structure\n\n### `app.ts`\n\n`app.ts` is the entry point for the application and is the file you'll run to\nstart the server. This project aims to keep this file as thin as possible,\nprimarily using it as a way to route inbound requests.\n\n### `manifest.json`\n\n`manifest.json` is a configuration for Slack apps. With a manifest, you can\ncreate an app with a pre-defined configuration, or adjust the configuration of\nan existing app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-ts-custom-function-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fbolt-ts-custom-function-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-ts-custom-function-template/lists"}