|
| 1 | +# Bolt for Java Template App |
| 2 | + |
| 3 | +This is a generic Bolt for Java template app used to build out Slack apps. |
| 4 | + |
| 5 | +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](https://slack.com/create). |
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +#### Create a Slack App |
| 10 | + |
| 11 | +1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and choose "From an app manifest" |
| 12 | +2. Choose the workspace you want to install the application to |
| 13 | +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* |
| 14 | +4. Review the configuration and click *Create* |
| 15 | +5. Click *Install to Workspace* and *Allow* on the screen that follows. You'll then be redirected to the App Configuration dashboard. |
| 16 | + |
| 17 | +#### Environment Variables |
| 18 | + |
| 19 | +Before you can run the app, you'll need to store some environment variables. |
| 20 | + |
| 21 | +1. Open your app's configuration page from this list, click **OAuth & Permissions** in the left hand menu, then copy the Bot User OAuth Token. You will store this in your environment as `SLACK_BOT_TOKEN`. |
| 22 | +2. 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 this token. You will store this in your environment as `SLACK_APP_TOKEN`. |
| 23 | + |
| 24 | +```zsh |
| 25 | +# Replace with your app token and bot token |
| 26 | +export SLACK_BOT_TOKEN=<your-bot-token> |
| 27 | +export SLACK_APP_TOKEN=<your-app-token> |
| 28 | +``` |
| 29 | + |
| 30 | +### Setup Your Local Project |
| 31 | + |
| 32 | +```zsh |
| 33 | +# Clone this project onto your machine |
| 34 | +git clone https://github.com/slack-samples/bolt-java-starter-template.git |
| 35 | + |
| 36 | +# Change into this project directory |
| 37 | +cd bolt-java-template |
| 38 | +``` |
| 39 | + |
| 40 | +#### Maven: Run |
| 41 | + |
| 42 | +Ensure [maven](https://maven.apache.org/index.html) is installed on your local environment. |
| 43 | +* We recommend using [brew to install Maven on macOS](https://formulae.brew.sh/formula/maven) |
| 44 | + |
| 45 | +```zsh |
| 46 | +# Install the dependencies and compile |
| 47 | +mvn clean compile |
| 48 | + |
| 49 | +# apply linter to your project |
| 50 | +mvn spotless:apply |
| 51 | + |
| 52 | +# Install the dependencies and test |
| 53 | +mvn clean test |
| 54 | + |
| 55 | +# Compile and start your local server |
| 56 | +mvn clean compile exec:java -Dexec.mainClass="Main" |
| 57 | +``` |
| 58 | + |
| 59 | +**NOTE**: If you chose to use Maven as your build tool you can remove the `builde.gradle` file from this project. |
| 60 | + |
| 61 | +------ |
| 62 | + |
| 63 | +#### Gradle: Run |
| 64 | + |
| 65 | +Ensure [gradle](https://gradle.org/) is installed on your local environment. |
| 66 | +* We recommend using [brew to install Gradle on macOS](https://formulae.brew.sh/formula/gradle) |
| 67 | + |
| 68 | +```zsh |
| 69 | +# Run tests |
| 70 | +gradle test |
| 71 | + |
| 72 | +# Apply linter to project |
| 73 | +gradle spotlessApply |
| 74 | + |
| 75 | +# Start your local server |
| 76 | +gradle run |
| 77 | +``` |
| 78 | + |
| 79 | +**NOTE**: If you chose to use Gradle as your build tool you can remove the `pom.xml` file from this project. |
| 80 | + |
| 81 | +## Project Structure |
| 82 | + |
| 83 | +### `manifest.json` |
| 84 | + |
| 85 | +`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. |
| 86 | + |
| 87 | +### `Main.java` |
| 88 | + |
| 89 | +`./src/main/java/Main.java` 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. |
| 90 | + |
| 91 | +### `/listeners` |
| 92 | + |
| 93 | +Every incoming request is routed to a "listener". Inside this directory, we group each listener based on the Slack Platform feature used, so `/listeners/shortcuts` handles incoming [Shortcuts](https://api.slack.com/interactivity/shortcuts) requests, `/listeners/views` handles [View submissions](https://api.slack.com/reference/interaction-payloads/views#view_submission), and so on. |
| 94 | + |
| 95 | +### `/logback.xml` |
| 96 | + |
| 97 | +[`logback-classic`](https://search.maven.org/artifact/ch.qos.logback/logback-classic) is imported as a dependency to configure the logs of the project, this configuration is defined in a [logback.xml](https://logback.qos.ch/manual/configuration.html) found in `src/main/resources/logback.xml`. Note that by default the project should be logging `debug` level logs for slack dependencies. |
| 98 | + |
| 99 | +### Tests |
| 100 | + |
| 101 | +This project provides some sample unit tests. They can be found in `src/test`. They are to be used as examples to show how unit tests can be implemented. **As you modify this project don't hesitate to modify, add, or remove these tests.** |
| 102 | + |
| 103 | +## App Distribution / OAuth |
| 104 | + |
| 105 | +Only implement OAuth if you plan to distribute your application across multiple workspaces. A separate `OAuthMain.java` file can be found with relevant OAuth settings. |
| 106 | + |
| 107 | +When using OAuth, Slack requires a public URL where it can send requests. In this template app, we've used [`ngrok`](https://ngrok.com/download). Checkout [this guide](https://ngrok.com/docs#getting-started-expose) for setting it up. |
| 108 | + |
| 109 | +Start `ngrok` to access the app on an external network and create a redirect URL for OAuth. |
| 110 | + |
| 111 | +``` |
| 112 | +ngrok http 3000 |
| 113 | +``` |
| 114 | + |
| 115 | +This output should include a forwarding address for `http` and `https` (we'll use `https`). It should look something like the following: |
| 116 | + |
| 117 | +``` |
| 118 | +Forwarding https://3cb89939.ngrok.io -> http://localhost:3000 |
| 119 | +``` |
| 120 | + |
| 121 | +Navigate to **OAuth & Permissions** in your app configuration and click **Add a Redirect URL**. The redirect URL should be set to your `ngrok` forwarding address with the `slack/oauth/callback` path appended. For example: |
| 122 | + |
| 123 | +``` |
| 124 | +https://3cb89939.ngrok.io/slack/oauth/callback |
| 125 | +``` |
| 126 | + |
| 127 | +*NOTE:* if you do not require OAuth you can remove all `OAUTH DEPENDENCIES` in the `pom.xml` or `build.gradle` files, along with `src/main/java/OAuthMain.java` |
0 commit comments