https://github.com/bredefk/slack-bot

Spring-Boot Slack bot: Bot for slashcommands (+other) in Slack
https://github.com/bredefk/slack-bot

bot hibernate ip java slack spring-boot

Last synced: 13 days ago
JSON representation

Spring-Boot Slack bot: Bot for slashcommands (+other) in Slack

• Host: GitHub
• URL: https://github.com/bredefk/slack-bot
• Owner: BredeFK
• License: gpl-3.0
• Created: 2019-10-16T06:30:07.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-21T10:45:14.000Z (over 1 year ago)
• Last Synced: 2024-06-12T17:59:30.570Z (5 months ago)
• Topics: bot, hibernate, ip, java, slack, spring-boot
• Language: Java
• Homepage:
• Size: 365 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Alfred Pennyworth (_aka Batman's Butler_)

## About

This bot is only written in Java (with Docker and MakeFile to deploy) and is a bot in slack

where the user can get a daily quote or checkup a GitHub user and then check her/his repositories one at the time.

This project uses api's from _https://quotes.rest/qod_ for quotes, _https://api.github.com/users/_ for getting github users and repositories, 

_https://www.harmannenfalt.no/api_ and _https://www.hardovrefalt.no/api_ for getting info about the mountains Mannen and Dovre have fallen or not.

## Functionality

* Daily quote will be sent every day at 09:15

* `/quote` returns a daily quote

![](https://i.imgur.com/J8nQb1K.png)

* `/mannen` responds with a message if the mountain Mannen has fallen or not

![](https://i.imgur.com/xZze14R.png)

* `/dovre` responds with a message if the mountain Dovre has fallen or not

![](https://i.imgur.com/gbR2xlm.png)

* `/github ` returns the user if they exist

![](https://i.imgur.com/qZyvGVc.png)

    

    

* `Select a repository` and information will be returned about it.

![](https://i.imgur.com/uUqkhjK.png)

(I used [this](https://api.slack.com/tools/block-kit-builder) website to check how the JSON's should look before posting them to slacks api)

## Templates

See [Templates](Templates.md) for better understanding of all `toJson()` functions.

## Technologies

* TomCat

* Java

* Maven

* Docker

## Frameworks

* Spring Boot

* Hibernate

## You will need

* Docker

* maven

* make

* git

## Requirements

* Open port `8080`

* make `sudo apt install make`

* mvn `sudo apt install maven`

* docker `sudo apt install docker.io -y`

## Deployment

1. Clone this repository `git clone https://gitlab.com/BredeFK/alfred.git`

1. Open `Dockerfile` and add all environment variables

1. Run `make build`

## SonarQube

1. [Download and start SonarQube server](https://docs.sonarqube.org/latest/setup/get-started-2-minutes/)

1. run `mvn clean verify sonar:sonar`

1. or run `mvn sonar:sonar` if project is unchanged

### Makefile

* make build

* make clean

* make run

* make status

## Managing deployment

* To check logs on running deployment `screen -r`

* To check status and ID on running container `docker container ls`

* To stop deployment `docker container stop ` or `screen -r` and `ctrl + c`

## Bonus

* This project has a nice front-end for error page.

* It has an Privacy Policy.

* It will soon track ip address and give location in logs, but not store them!