-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
3,867 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2022- Slack Technologies, LLC | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,174 @@ | ||
# Deno Hello World Slack App | ||
|
||
This sample app demonstrates how to use a function, workflow, and trigger to | ||
send a greeting to channel. | ||
|
||
**Guide Outline**: | ||
|
||
- [Setup](#setup) | ||
- [Install the Slack CLI](#install-the-slack-cli) | ||
- [Clone the Template](#clone-the-template) | ||
- [Create a Link Trigger](#create-a-link-trigger) | ||
- [Running Your Project Locally](#running-your-project-locally) | ||
- [Testing](#testing) | ||
- [Deploying Your App](#deploying-your-app) | ||
- [Viewing Activity Logs](#viewing-activity-logs) | ||
- [Project Structure](#project-structure) | ||
- [Resources](#resources) | ||
|
||
--- | ||
|
||
## Setup | ||
|
||
Before getting started, make sure you have a development workspace where you | ||
have permissions to install apps. If you don’t have one set up, go ahead and | ||
[create one](https://slack.com/create). Also, please note that the workspace | ||
requires any of [the Slack paid plans](https://slack.com/pricing). | ||
|
||
### Install the Slack CLI | ||
|
||
To use this sample, you first need to install and configure the Slack CLI. | ||
Step-by-step instructions can be found in our | ||
[Quickstart Guide](https://api.slack.com/future/quickstart). | ||
|
||
### Clone the Sample | ||
|
||
Start by cloning this repository: | ||
|
||
```zsh | ||
# Clone this project onto your machine | ||
$ slack create my-app -t slack-samples/deno-hello-world | ||
|
||
# Change into this project directory | ||
$ cd my-app | ||
``` | ||
|
||
## Create a Link Trigger | ||
|
||
[Triggers](https://api.slack.com/future/triggers) are what cause workflows to | ||
run. These triggers can be invoked by a user, or automatically as a response to | ||
an event within Slack. | ||
|
||
A [link trigger](https://api.slack.com/future/triggers/link) is a type of | ||
trigger that generates a **Shortcut URL** which, when posted in a channel or | ||
added as a bookmark, becomes a link. When clicked, the link trigger will run the | ||
associated workflow. | ||
|
||
Link triggers are _unique to each installed version of your app_. This means | ||
that Shortcut URLs will be different across each workspace, as well as between | ||
[locally run](#running-your-project-locally) and | ||
[deployed apps](#deploying-your-app). When creating a trigger, you must select | ||
the Workspace that you'd like to create the trigger in. Each Workspace has a | ||
development version (denoted by `(local)`), as well as a deployed version. | ||
|
||
To create a link trigger for the workflow in this sample, run the following | ||
command: | ||
|
||
```zsh | ||
$ slack trigger create --trigger-def triggers/greeting_trigger.ts | ||
``` | ||
|
||
After selecting a Workspace, the output provided will include the link trigger | ||
Shortcut URL. Copy and paste this URL into a channel as a message, or add it as | ||
a bookmark in a channel of the Workspace you selected. | ||
|
||
**Note: this link won't run the workflow until the app is either running locally | ||
or deployed!** Read on to learn how to run your app locally and eventually | ||
deploy it to Slack hosting. | ||
|
||
## Running Your Project Locally | ||
|
||
While building your app, you can see your changes propagated to your workspace | ||
in real-time with `slack run`. In both the CLI and in Slack, you'll know an app | ||
is the development version if the name has the string `(local)` appended. | ||
|
||
```zsh | ||
# Run app locally | ||
$ slack run | ||
|
||
Connected, awaiting events | ||
``` | ||
|
||
Once running, click the | ||
[previously created Shortcut URL](#create-a-link-trigger) associated with the | ||
`(local)` version of your app. This should start the included sample workflow. | ||
|
||
To stop running locally, press `<CTRL> + C` to end the process. | ||
|
||
## Testing | ||
|
||
For an example of how to test a function, see | ||
`functions/greeting_function_test.ts`. Test filenames should be suffixed with | ||
`_test`. | ||
|
||
Run all tests with `deno test`: | ||
|
||
```zsh | ||
$ deno test | ||
``` | ||
|
||
## Deploying Your App | ||
|
||
Once you're done with development, you can deploy the production version of your | ||
app to Slack hosting using `slack deploy`: | ||
|
||
```zsh | ||
$ slack deploy | ||
``` | ||
|
||
After deploying, [create a new link trigger](#create-a-link-trigger) for the | ||
production version of your app (not appended with `(local)`). Once the trigger | ||
is invoked, the workflow should run just as it did in when developing locally. | ||
|
||
### Viewing Activity Logs | ||
|
||
Activity logs for the production instance of your application can be viewed with | ||
the `slack activity` command: | ||
|
||
```zsh | ||
$ slack activity | ||
``` | ||
|
||
## Project Structure | ||
|
||
### `manifest.ts` | ||
|
||
The [app manifest](https://api.slack.com/future/manifest) contains the app's | ||
configuration. This file defines attributes like app name and description. | ||
|
||
### `slack.json` | ||
|
||
Used by the CLI to interact with the project's SDK dependencies. It contains | ||
script hooks that are executed by the CLI and implemented by the SDK. | ||
|
||
### `/functions` | ||
|
||
[Functions](https://api.slack.com/future/functions) are reusable building blocks | ||
of automation that accept inputs, perform calculations, and provide outputs. | ||
Functions can be used independently or as steps in workflows. | ||
|
||
### `/workflows` | ||
|
||
A [workflow](https://api.slack.com/future/workflows) is a set of steps that are | ||
executed in order. Each step in a workflow is a function. | ||
|
||
Workflows can be configured to run without user input or they can collect input | ||
by beginning with a [form](https://api.slack.com/future/forms) before continuing | ||
to the next step. | ||
|
||
### `/triggers` | ||
|
||
[Triggers](https://api.slack.com/future/triggers) determine when workflows are | ||
executed. A trigger file describes a scenario in which a workflow should be run, | ||
such as a user pressing a button or when a specific event occurs. | ||
|
||
## Resources | ||
|
||
To learn more about developing with the CLI, you can visit the following guides: | ||
|
||
- [Creating a new app with the CLI](https://api.slack.com/future/create) | ||
- [Configuring your app](https://api.slack.com/future/manifest) | ||
- [Developing locally](https://api.slack.com/future/run) | ||
|
||
To view all documentation and guides available, visit the | ||
[Overview page](https://api.slack.com/future/overview). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"importMap": "import_map.json", | ||
"tasks": { | ||
"test": "deno fmt --check && deno lint && deno test --allow-read --allow-none" | ||
} | ||
} |
Oops, something went wrong.