Skip to content

Commit

Permalink
Add basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MathieuLamiot committed Jul 26, 2023
1 parent 913d385 commit 8aec312
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# TechTeamBot
This app is a helper bot template for Tech teams, leveraging Slack and github integartions for better agile workflows.

## Configuration
To run the app, you must first configure it with Slack and Github information, including credentials.
To do so, fill the different json files in the config folder.

### Slack integration
The Slack integartion requires the app to be declared and installed as a Slack App. The "interactivity" feature must be configured and webhooks directed to the app server.

## Running the app
Run the script app.py
The app will listen on the configured port for API calls.

## Features
### Create GitHub tasks from Slack
The Slack app adds a shortcut to create a GitHub task in the configured GitHub Project(V2). When triggered, a modal is opened to fill out information related to the task.

0 comments on commit 8aec312

Please sign in to comment.