search

slack-samples / bolt-js-custom-step-template

A template for building automations with Bolt for JavaScript
MIT License
3 stars 1 forks source link

readme

Bolt for JavaScript Custom Step Template

This is a Bolt for JavaScript template app used to build custom steps for use in 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.

Developer Program

Join the Slack 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 and choose "From an app manifest"
  2. Choose the workspace you want to install the application to
  3. Copy the contents of 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, 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

# Clone this project onto your machine
git clone https://github.com/slack-samples/bolt-js-custom-step-template.git

# Change into this project directory
cd bolt-js-custom-step-template

# Install dependencies
npm install

# Run Bolt server
npm start

Linting

Run linter for code formatting and linting:

npm run lint

Using Steps in Workflow Builder

With your server running, your step is now ready for use in 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.

Project Structure

app.js

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.

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.