This Bolt for JavaScript template demonstrates how to build Agents & Assistants in Slack.
Models from the Hugging Face platform are used and can be customized for prompts of all kinds.
Before 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.
Join the Slack Developer Program for exclusive access to sandbox environments for building and testing your apps, tooling, and resources created to help you build and grow.
- Open https://api.slack.com/apps/new and choose "From an app manifest"
- Choose the workspace you want to install the application to
- Copy the contents of manifest.json into the text box that
says
*Paste your manifest code here*
(within the JSON tab) and click Next - Review the configuration and click Create
- You'll then be redirected to App Settings. Visit the Install App page and install your app.
Before you can run the app, you'll need to store some environment variables.
- Rename
.env.sample
to.env
- 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 underSLACK_BOT_TOKEN
- 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
asSLACK_APP_TOKEN
.
A fine grained access token with the "Make calls to Inference Providers" permission from Hugging Face is also needed. Store this as HUGGINGFACE_API_KEY
.
# Clone this project onto your machine
git clone https://github.com/slack-samples/bolt-js-assistant-template.git
# Change into this project directory
cd bolt-js-assistant-template
# Install dependencies
npm install
# Run Bolt server
npm start
# Run lint for code formatting and linting
npm run lint
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.
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.