Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anonrig/slack-manager
Agile Development tool for Slack. Basically, "Standup Meetings in Slack".
https://github.com/anonrig/slack-manager
Last synced: about 2 months ago
JSON representation
Agile Development tool for Slack. Basically, "Standup Meetings in Slack".
- Host: GitHub
- URL: https://github.com/anonrig/slack-manager
- Owner: anonrig
- Created: 2015-12-27T20:36:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-29T19:31:50.000Z (almost 7 years ago)
- Last Synced: 2024-05-28T14:23:23.311Z (4 months ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 219
- Watchers: 9
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agile Development tool for Slack.
Basically, "**Standup meetings for Slack**"
Slack Manager allows teams to monitor employees on a daily basis. You can start a meeting by inviting your bot to your current channel and just write "start meeting".
Advantages of Slack Manager from other services:
- Free and easy to use.
- Configurable mail settings.
- Configurable questions.
- Works with multiple channels.
### Create your Slack bot.
- First make a bot integration inside of your Slack channel. Go here: `https://my.slack.com/services/new/bot`
- Enter a name for your bot. Make it something fun and friendly, but avoid a single task specific name. Bots can do lots! Let's not pigeonhole them.
- When you click "Add Bot Integration", you are taken to a page where you can add additional details about your bot, like an avatar, as well as customize its name & description.
Copy the API token that Slack gives you. You'll need it in the next step.
### Installation
Clone the repository by:
```
git clone https://github.com/anonrig/slack-manager
```
Install from NPM
```
npm install slack-manager --save
```
Create your settings file.
```
touch config/production.json
```
Mailer service uses nodemailer's transport methods. Therefore, for better understanding please read nodemailer's [available transports ](https://github.com/andris9/Nodemailer#available-transports).
For example for Gmail settings: change your settings file by:
```
{
"token": "YOUR SLACK TOKEN HERE",
"mailer": {
"service": "Gmail",
"email": "[email protected]",
"pass": "mySuperFancyPassword"
}
}
```
Configure your questions
Open default.json and add a questions field shown below.
slack-manager lets users to ask different questions to different channels. If you prefer a single question list
then you will only need the default field of the questions object. If you want to ask different questions to different channels
then you will need to add additional fields to the questions object. Fields of the questions object must be the names of the
corresponding channels.
Note: If no questions that has the same name as the channel found then the default list will be asked.
```
"questions": {
"default": [
"What did you do yesterday?",
"What are you going to do today?",
"Did you encounter any problems?"
],
"CHANNEL-NAME": [
"How do you feel?"
],
"ANOTHER-CHANNEL-NAME": [
"Another question?",
"Perhaps more?"
]
}
```
## Usage
### Install dependencies
```
npm install
```
### Start your bot.
```
npm start
```
### Commands
- ``` start meeting ```
Starts meeting. To be able to start meeting with this command your bot should be invited to the channel.
- ``` skip ```
Skips the current user's turn. Asks/Returns to the skipped users again at the end of the meeting. Can be skipped more than once.
- ``` dismiss ```
Dismisses the current user, in other words kicks the current user out of the meeting. Useful in case of an absence.
- ``` quit ```
Ends the meeting. Meeting can be restarted by typing ``` start meeting ``` again.
### Tech
Slack-Manager uses a number of open source projects to work properly:
* [Botkit](https://github.com/howdyai/botkit) - Botkit - Building Blocks for Building Bots
* [Node-mailer](https://github.com/andris9/Nodemailer) - Send e-mails with Node.JS – easy as cake! E-mail made in Estonia.
* [Lodash](https://github.com/lodash/lodash) - A JavaScript utility library delivering consistency, modularity, performance, & extras.
* [Async](https://github.com/caolan/async) - Async utilities for node and the browser.
* [Nconf](https://github.com/indexzero/nconf) - Hierarchical node.js configuration with files, environment variables, command-line arguments, and atomic object merging.
### Development
Want to contribute? Great! Feel free to submit bugs, and open pull requests.
License
----
MIT