https://github.com/sharovik/devbot
Golang slack chat-bot
https://github.com/sharovik/devbot
api automation bitbucket bot chatbot deployment devbot development framework go golang slack slack-bot
Last synced: 3 months ago
JSON representation
Golang slack chat-bot
- Host: GitHub
- URL: https://github.com/sharovik/devbot
- Owner: sharovik
- License: bsd-3-clause
- Created: 2019-11-23T13:41:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T19:45:23.000Z (over 1 year ago)
- Last Synced: 2024-08-26T22:59:42.164Z (over 1 year ago)
- Topics: api, automation, bitbucket, bot, chatbot, deployment, devbot, development, framework, go, golang, slack, slack-bot
- Language: Go
- Homepage:
- Size: 141 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# devbot
[](https://gitter.im/devbot-tool/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Free, opensource "ChatBot" project, based on GoLang. Using this project you can build your custom simple bot, which can execute the commands you need.
## Table of contents
- [How to run](#how-to-run)
- [Prerequisites](documentation/prerequisites.md)
- [Install to AWS](documentation/terraform-aws-setup.md)
- [How to write custom event](documentation/events.md)
- [How to build scenario](documentation/scenarios.md)
- [How to schedule scenario](documentation/schedules.md)
- [Migrations](documentation/migrations.md)
- [Features out of the box](documentation/features-out-of-the-box.md)
- [Internal functionalities](documentation/available-features.md)
- [Events available for installation](#custom-events-available-for-installation)
- [Project build](documentation/build.md)
- [Authors](#authors)
- [License](#license)
## How to run
Build the project, [you can find the instructions here](documentation/build.md)
Once project build finished, please run the following command:
**For macOS and Linux**
```
./bin/devbot-current-system
```
For windows
```
start bin\devbot-current-system.exe
```
### Run by using docker
**Before run, make sure you created `.env` file and set up the credentials**
1. Build the image. To do that, please run the following command:
```
docker build --target base -t devbot-app-base:latest .
docker build --target run -t devbot-app-run:latest .
```
2. If build was successful, please use the following command to run the container
```
docker run --env-file=.env devbot-app-run:latest
```
### Run using docker compose
Execute command `docker compose up`
## Custom events available for installation
Here you can find an examples of custom events, which are ready for installation
- [WordPress theme generation event](https://github.com/sharovik/themer-wordpress-event)
- [BitBucket release event](https://github.com/sharovik/bitbucket-release-event)
- [BitBucket run pipeline event](https://github.com/sharovik/bitbucket-run-pipeline)
## Authors
* **Pavel Simzicov** - *Main work* - [sharovik](https://github.com/sharovik)
### Vendors used
* github.com/joho/godotenv - for env files loading
* github.com/sharovik/orm - the ORM for database queries
* github.com/karalabe/xgo - for cross-platform build
* github.com/pkg/errors - for errors wrapper and trace extracting in logger
* github.com/rs/zerolog - for logger
* github.com/stretchr/testify - for asserts in tests
* golang.org/x/net - for websocket connection
## License
This project licensed under the BSD License - see the [LICENSE.md](LICENSE.md) file for details