Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/the-programmers-hangout/lighthouse

A simple discord bot that allows members to alert staff
https://github.com/the-programmers-hangout/lighthouse

Last synced: about 14 hours ago
JSON representation

A simple discord bot that allows members to alert staff

Host: GitHub
URL: https://github.com/the-programmers-hangout/lighthouse
Owner: the-programmers-hangout
License: mit
Created: 2020-12-04T13:49:23.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2022-09-10T19:44:11.000Z (about 2 years ago)
Last Synced: 2023-03-03T07:59:28.255Z (over 1 year ago)
Language: Kotlin
Size: 126 KB
Stars: 1
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

A simple discord bot that allows members to alert staff.

## Required Permissions
- Read Messages
- Send Messages
- Embed Links
- Add Reactions

The bot will also either need the `Mention @everyone, @here, and All Roles` permission **OR** (suggested) a channel override for your configured alert channel.

## Commands
Refer to [commands.md](commands.md) for a general list and explanation of all available commands. To learn about commands during runtime, use the `help` command!

## Getting Started ⚙️
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Requirements
- Docker
- Docker-Compose (compatible with docker-compose version 3.8)

Get the Docker version you need [here](https://hub.docker.com/search?q=docker&type=edition&offering=community)!

### Setup
Since this bot has a **docker-compose.yml** file and is hosted on [DockerHub](https://hub.docker.com/r/theprogrammershangout/lighthouse), all you need to start your own version of Lighthouse locally is to `clone` this repository and set up the **.env** file.

The **.env** file is used to configure the bot token and owner id, in the following format:

```
BOT_TOKEN=
BOT_OWNER=
```

#### For **Linux** and **Mac** run
```console
$ cp .env.example .env
```

#### For **Windows** run
```powershell
> Copy-Item .env.example .env
```

Edit the **.env** file with your favourite editor, filling out the following properties:
- **BOT_TOKEN** (you can find the bot token under `https://discord.com/developers/applications/bot-id/bot` for an overview of all your bots visit https://discord.com/developers/applications)
- **BOT_OWNER** ([Where can I find my User/Server/Message ID?](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-))

Run the bot via `docker-compose`
```console
$ docker-compose up --build --detach
```

## Versioning 🏷️
This project uses [Semantic Versioning](http://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/the-programmers-hangout/Lighthouse/tags/) on this repository.

## Authors 👤
* **Moe Szyslak** - *Original Author* - [@Moe-Szyslak](https://github.com/Moe-Szyslak)

See also the list of [contributors](https://github.com/the-programmers-hangout/Lighthouse/graphs/contributors) who participated in this project.

## Contributing 🤝
Contributions, issues and feature requests are welcome! Feel free to check the [issues page](https://github.com/the-programmers-hangout/Lighthouse/issues).

## Setup development environment 🛠️
For development you don't necessarily need **Docker** and **Docker-Compose** but **Java**
- `clone` this repository
- Open the project in your favourite Java / Kotlin IDE (JetBrains [IntelliJ IDEA](https://www.jetbrains.com/idea/) is the recommended IDE for Kotlin projects)
- For running the bot within your IDE you need to add your bot token as `program argument` or `environment variable` (You might have to figure out how to do that in your IDE. **IntelliJ** let's you do that under `Run -> Edit Configurations...`)

## Show your support ⭐️
Give a ⭐️ if this project helped you!