https://github.com/slack-samples/bolt-ts-definition-app

A Slack app for storing and accessing company specific phrases
https://github.com/slack-samples/bolt-ts-definition-app

sample-app slack slack-app slackapi

Last synced: 5 months ago
JSON representation

A Slack app for storing and accessing company specific phrases

• Host: GitHub
• URL: https://github.com/slack-samples/bolt-ts-definition-app
• Owner: slackapi
• License: mit
• Created: 2019-10-25T19:10:50.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-07-18T20:15:39.000Z (over 2 years ago)
• Last Synced: 2024-10-04T21:35:46.296Z (over 1 year ago)
• Topics: sample-app, slack, slack-app, slackapi
• Language: TypeScript
• Homepage:
• Size: 1.31 MB
• Stars: 23
• Watchers: 7
• Forks: 9
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Definition App

![Linter](https://github.com/slackapi/definition-app/workflows/Linter/badge.svg)

![Unit Tests](https://github.com/slackapi/definition-app/workflows/Unit%20Tests/badge.svg)

An app for storing and accessing company specific phrases

## Screenshots

![Searching definitions](docs/define-demo.gif)

_Searching definitions_

---

![Adding definitions](docs/define-add-demo.gif)

_Adding definitions_

## Installation

### A note of caution!

Whilst Definition implements the Slack oAuth flow, this is purely to support Enterprise Grid Installations. You should *not* install it on multiple public workspaces as the code does *not* make a distinction between workspaces when retrieving terms. Any user can access *any* term/definition pair in the system.

### Instructions

[Click here](docs/SETUP.md) for a step by step guide.

## Other implmentations

If TypeScript isn't your preferred language, here are other open source projects that implement similar functionality, built by community developers.

### Python

- [Whatis](https://github.com/wooddar/whatis)