https://github.com/slack-samples/bolt-ts-custom-step-template
A template for building automations with Bolt for JavaScript (TypeScript)
https://github.com/slack-samples/bolt-ts-custom-step-template
Last synced: 9 months ago
JSON representation
A template for building automations with Bolt for JavaScript (TypeScript)
- Host: GitHub
- URL: https://github.com/slack-samples/bolt-ts-custom-step-template
- Owner: slack-samples
- License: mit
- Created: 2024-08-14T16:32:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-02T17:53:54.000Z (10 months ago)
- Last Synced: 2025-09-02T19:25:07.948Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 226 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bolt for JavaScript (TypeScript) Custom Step Template
This is a Bolt for JavaScript (TypeScript) template app used to build custom
steps for use in
[Workflow Builder](https://api.slack.com/start#workflow-builder).
## Setup
Before getting started, first make sure you have a development workspace where
you have permission to install apps. **Please note that the features in this
project require that the workspace be part of
[a Slack paid plan](https://slack.com/pricing).**
### Developer Program
Join 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 developers build and grow.
## Installation
### Create a Slack App
1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and
choose "From an app manifest"
2. Choose the workspace you want to install the application to
3. Copy the contents of [manifest.json](./manifest.json) into the text box that
says `*Paste your manifest code here*` (within the JSON tab) and click _Next_
4. Review the configuration and click _Create_
5. Click _Install_ button and _Allow_ on the screen that follows. You'll then be
redirected to the App Settings dashboard.
### Environment Variables
Before you can run the app, you'll need to store some environment variables.
1. Rename `.env.sample` to `.env`
2. Open your apps setting page from
[this list](https://api.slack.com/apps), click _OAuth & Permissions_ in the
left hand menu, then copy the _Bot User OAuth Token_ into your `.env` file
under `SLACK_BOT_TOKEN`
3. Click _Basic Information_ from the left hand menu and follow the steps in the
_App-Level Tokens_ section to create an app-level token with the
`connections:write` scope. Copy that token into your `.env` as
`SLACK_APP_TOKEN`.
### Local Project
```zsh
# Clone this project onto your machine
git clone https://github.com/slack-samples/bolt-ts-custom-step-template.git
# Change into this project directory
cd bolt-ts-custom-step-template
# Install dependencies
npm install
# Run Bolt server
npm start
```
### Testing
Run the TypeScript compilation, code formatting and linting:
```zsh
npm test
```
## Using Steps in Workflow Builder
With your server running, your step is now ready for use in
[Workflow Builder](https://api.slack.com/start#workflow-builder)! Add it as a
custom step in a new or existing workflow, then run the workflow while your app
is running.
For more information on creating workflows and adding custom steps, read more
[here](https://slack.com/help/articles/17542172840595-Create-a-new-workflow-in-Slack).
## Project Structure
### `app.ts`
`app.ts` 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.
### `manifest.json`
`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.