Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codica2/timebot
:robot: Timebot is a Slack bot for helping with everyday timesheet
https://github.com/codica2/timebot
rails rails-api rails-application rails5 slack slack-bot timebot
Last synced: 27 days ago
JSON representation
:robot: Timebot is a Slack bot for helping with everyday timesheet
- Host: GitHub
- URL: https://github.com/codica2/timebot
- Owner: codica2
- Created: 2016-08-15T11:07:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-12T08:34:37.000Z (over 5 years ago)
- Last Synced: 2024-09-27T15:22:33.635Z (about 1 month ago)
- Topics: rails, rails-api, rails-application, rails5, slack, slack-bot, timebot
- Language: Ruby
- Homepage:
- Size: 5.09 MB
- Stars: 28
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Slack Time-Tracking Bot
**Timebot** is a time-tracking system allowing to enter the number of hours spent on a particular project and monitor a development workflow as a whole. The information will reflect in each member’s timesheet, which can be later viewed and edited.
## Сore Functionality
##### 1. Time tracking
OR
##### 2. Absences
##### 3. Reports
##### 4. Projects
## All available commands
| Commands | Description |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `help` | print help. |
| `projects` | print all available projects projects. |
| `find project SEARCH_QUERY` | find specific project. |
| `PROJECT_NAME HOURS:MINUTES COMMENT` | log time. |
| `/logtime` | log time via interective dialog. |
| `edit NEW_DATE(OPTIONAL) TIME_ENTRY_ID HOURS:MINUTES COMMENT` | edit an existing time entry. |
| `update(OPTIONAL) DAY.MONTH.YEAR PROJECT_NAME HOURS:MINUTES COMMENT` | create an entry for the specific date. |
| `add project PROJECT_NAME` | add new project. |
| `show day`/`show week`/`show month` | get report for this day/week/month. |
| `show absence`/`show absence last year` | display absences. |
| `set REASON DAY.MONTH.YEAR(OPTIONAL) - DAY.MONTH.YEAR(OPTIONAL) COMMENT(OPTIONAL)` | if you were/will be absent on some days. |
## API Documentation
The application also provides comprehensive API documentation for integrating client applications. [Full docs can be found here](https://gitlab.codica.com/codica2/timebot/blob/feature/readme/docs.md)
## How to install for your team?
### Requirements
- `rails 5.0`
- `ruby 2.3.3`
- `PostgresQL`
### Getting started
**Step 1:** Clone the app
```shell
git clone [email protected]:codica2/timebot.git
cd timebot
```
**Step 2** Add environment variables to **.env** (*create file if don't exist*)
```
SECRET_KEY_BASE=`secret_key_base`
SLACK_TOKEN=`slack_token`
TIMEBOT_APP_TOKEN=`slack_timebot_app_token`
TRELLO_MEMBER_TOKEN=`member_token`
```
1. [How to get](#user-content--secret-key-base) `secret_key_base`
2. [How to get](#user-content--adding-slack-bot-integration) `slack_token`
3. [How to get](#user-content--building-slack-app) `slack_timebot_app_token`
4. [How to get](#user-content--trello-integration) `member_token`
**Step 3:** Add config files:
```shell
mv config/database.yml.example config/database.yml
```
**Step 4:** Install the app's dependencies:
```shell
bundle install && bundle exec rake db:create && bundle exec rake db:migrate
```
### Integrations
---
#### [](#slack_timebot_app_token) Building Slack App
1 Go to [Slack API](http://https://api.slack.com "Slack API")
2 Click **Start Building** button
3 In the dialog that opens, select the name of your application and the workspace in which your application should work.
4 After successful creation:
- Go to the slash command tab
- Press **Add new command** button
- Fill Command field with **/logtime**
- Fill Request URL with **https://your_domain_name.com/api/v1/slack/command**
- Press save
5 Go to Interactive Components tab
- Fill Request URL field with **https://your_domain_name.com/api/v1/slack/submission**
- Press save
6 Add Bot user on **Bot users** tab
7 Got to OAuth & Permissions tab
- Press **Install App to Workspace** button
- Copy `Bot User OAuth Access Token` and paste to **.env** `slack_timebot_app_token=`
#### [](#slack_token) Adding Slack Bot integration
1 Choose your workspace
2 Add configuration
3 Choose a name for your slack bot
4 Get your `slack_token`
#### [](#member_token) Trello integration
[Hot to get trello token read here](https://developers.trello.com/v1.0/reference#introduction)
#### [](#secret_key_base) Secret key base
Just run `rake secret`
## License
Timebot is Copyright © 2015-2019 Codica. It is released under the [MIT License](https://opensource.org/licenses/MIT).
## About Codica
[](https://www.codica.com)
Timebot is maintained and funded by Codica. The names and logos for Codica are trademarks of Codica.
We love open source software! See [our other projects](https://github.com/codica2) or [hire us](https://www.codica.com/) to design, develop, and grow your product.