Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yukinagae/genkit-firebase-functions-slack-bolt-sample
Sample project for learning Firebase Genkit and deploying to Firebase Functions and Slack bolt app
https://github.com/yukinagae/genkit-firebase-functions-slack-bolt-sample
firebase firebase-functions genkit genkitx openai secret-manager slack slack-bolt
Last synced: about 2 months ago
JSON representation
Sample project for learning Firebase Genkit and deploying to Firebase Functions and Slack bolt app
- Host: GitHub
- URL: https://github.com/yukinagae/genkit-firebase-functions-slack-bolt-sample
- Owner: yukinagae
- Created: 2024-07-12T06:17:27.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-19T05:35:18.000Z (2 months ago)
- Last Synced: 2024-11-19T06:29:05.584Z (2 months ago)
- Topics: firebase, firebase-functions, genkit, genkitx, openai, secret-manager, slack, slack-bolt
- Language: TypeScript
- Homepage: https://medium.com/@yukinagae/build-a-slack-bot-app-with-firebase-genkit-in-just-100-lines-71d4e49c9e08
- Size: 199 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# genkit-firebase-functions-slack-bolt-sample
`genkit-firebase-functions-slack-bolt-sample` is a beginner-friendly guide to Firebase Genkit, an open-source framework for creating AI applications. This sample project offers a detailed tutorial on using Firebase Genkit and shows how to integrate Firebase Functions with a Slack Bolt app.
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- [Making Changes](#making-changes)
- [License](#license)
## Requirements
Before you start, make sure you have these installed:
- **Node.js** version 22 or later
- **npm**
- **Genkit**
- **Firebase CLI**
- **ngrok**
For Genkit installation, see the [Firebase Genkit - Get started](https://firebase.google.com/docs/genkit/get-started).
For Firebase CLI installation, see the [Firebase - Firebase CLI reference](https://firebase.google.com/docs/cli).
Check your installations by running:
```bash
$ node --version # the below version is on my environment
v22.7.0
$ npm --version # the below version is on my environment
10.8.2
$ genkit --version # the below version is on my environment
0.9.1
$ firebase --version # the below version is on my environment
13.15.4
$ ngrok --version # the below version is on my environment
ngrok version 3.3.0
```
**Important**: Ensure all subsequent commands are executed within the `functions` directory. To navigate to this directory, use the command `cd functions` and verify your current working directory if necessary.
## Setup
Install Project Dependencies: Open your terminal, navigate to this project's `functions` folder, and run:
```bash
$ npm install
```
## Usage
### Running Genkit Locally
Before running the project locally, you need to provide your OpenAI API key. This key allows your application to communicate with OpenAI's services. Replace `your_api_key` with the actual API key you obtained from OpenAI.
```bash
$ export OPENAI_API_KEY=your_api_key
```
To start the Genkit server on your local machine and automatically open your default web browser to http://localhost:4000, execute the following command in your terminal:
```bash
$ npm run genkit
```
### Setup Your Firebase Project
Before deploying your application, complete the following preparatory steps:
1. **Create a Firebase project**:
Navigate to the Firebase Console. Click on `Create a project` and follow the prompts to create a new Firebase project.
2. **Switch to the Blaze plan**:
Firebase Functions require the `Blaze (Pay as you go) plan` for deployment. In the Firebase Console, select your project, then navigate to the left side bar section to change your plan.
3. **Configure your Firebase project locally**:
Update the `.firebaserc` file in your project's root directory to include your Firebase project name:
```json
{
"projects": {
"default": "your_project_name"
}
}
```
### Setup Your Slack App
1. Navigate to [Slack - Your Apps](https://api.slack.com/apps) and click `Create New App`.
2. Choose `From an app manifest` option, select a workspace under `Pick a workspace to develop your app`, and then click `Next`.
3. In the app manifest JSON below, replace `[your_app_name]` with your app's name, paste the updated JSON, then proceed by clicking `Next` and `Create`.
```json
{
"display_information": {
"name": "[your_app_name]"
},
"features": {
"bot_user": {
"display_name": "[your_app_name]",
"always_online": true
}
},
"oauth_config": {
"scopes": {
"bot": [
"app_mentions:read",
"channels:history",
"chat:write",
"files:read"
]
}
},
"settings": {
"event_subscriptions": {
"request_url": "http://dummy/events",
"bot_events": ["app_mention"]
},
"org_deploy_enabled": false,
"socket_mode_enabled": false,
"token_rotation_enabled": false
}
}
```
4. Navigate to `Settings` and select `Install App`, then click `Install to Workspace` and `Allow` button.
5. Find your `Bot User OAuth Token` under `OAuth & Permissions`. This is your `SLACK_BOT_TOKEN` for later use.
6. Find your `Signing Secret` under `Basic Information`. This is your `SLACK_SIGNING_SECRET` for later use.
7. To add your bot to a Slack channel, use the command:
```bash
/invite @[your_app_name]
```
### Local Emulator
To facilitate local development and testing of Firebase Functions, use the Firebase Emulator Suite. Follow these steps to run your functions locally:
To run Firebase Functions locally using the emulator, set your secret values in `functions/.secret.local`:
```bash
$ cp -p ./.secret.local.example ./secret.local
$ vim ./secret.local # replace the secrets with your own values
OPENAI_API_KEY=your_api_key
SLACK_BOT_TOKEN=your_bot_token
SLACK_SIGNING_SECRET=your_signing_secret
```
To launch the emulator, execute:
```bash
$ npm run emulator
✔ functions[us-central1-slack]: http function initialized (http://127.0.0.1:5001/[your_project_name]/us-central1/slack).
```
To make your local emulator accessible online, use ngrok to forward port `5001`:
```bash
$ ngrok http 5001
Forwarding https://[your_ngrok_id].ngrok-free.app -> http://localhost:5001
```
This command provides a public URL. Replace [your_ngrok_id] in the URL `https://[your_ngrok_id].ngrok-free.app` with the ID provided by ngrok.
To configure Slack event subscriptions:
1. Go to the `Event Subscriptions` page on your Slack app's dashboard.
2. In the `Request URL` field, enter `https://[your_ngrok_id].ngrok-free.app/[your_project_name]/us-central1/slack/events`.
3. Wait for the `Request URL Verified` confirmation, then click the `Save changes` button.
To test in a Slack channel, mention your bot using `@[your_app_name]` followed by a greeting message, like so:
```bash
@[your_app_name] hello
```
If everything is set up correctly, you should see a response like this:
```text
Hello! How can I assist you today?
```
### Deploy
To authenticate with Firebase and access your projects, use the Firebase CLI login command:
```bash
$ firebase login
```
To keep your secret keys safe when using Firebase Functions, store then as secret values in Google Cloud Secret Manger:
```bash
$ firebase functions:secrets:set OPENAI_API_KEY
? Enter a value for OPENAI_API_KEY [input is hidden]
$ firebase functions:secrets:set SLACK_BOT_TOKEN
? Enter a value for SLACK_BOT_TOKEN [input is hidden]
$ firebase functions:secrets:set SLACK_SIGNING_SECRET
? Enter a value for SLACK_SIGNING_SECRET [input is hidden]
```
To confirm your secret keys are correctly stored as secrets, use the following command:
```bash
$ firebase functions:secrets:access OPENAI_API_KEY
your_api_key
$ firebase functions:secrets:access SLACK_BOT_TOKEN
your_bot_token
$ firebase functions:secrets:access SLACK_SIGNING_SECRET
your_signing_secret
```
After securing your secret keys, you're ready to deploy your application to Firebase Functions:
```bash
$ npm run deploy
```
To monitor the behavior and troubleshoot your deployed functions, view the logs:
```bash
$ npm run logs
```
The final step involves linking your deployed function to the Slack app for integration.
To configure Slack event subscriptions:
1. Go to the `Event Subscriptions` page on your Slack app's dashboard.
2. In the `Request URL` field, enter `https://slack-[your_function_id]-uc.a.run.app/events`.
3. Wait for the `Request URL Verified` confirmation, then click the `Save changes` button.
NOTE: Replace `[your_function_id]` with your Firebase project value, found in the Firebase Console under the Functions Dashboard.
To test in a Slack channel, mention your bot using `@[your_app_name]` followed by a greeting message, like so:
```bash
@[your_app_name] hello
```
## Making Changes
### Building the Project
After making changes, you might need to build the project to see your changes in action:
```bash
$ npm run build
```
### Formatting and Linting
To ensure your code follows the project's coding standards, run the formatting and linting tools:
```bash
$ npm run typecheck # type check without modifying files
$ npm run check # scan without modifying files
$ npm run fix # modify files
```
## License
MIT