-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,37 @@ | ||
# Fortress Discord Bot | ||
|
||
## Steps | ||
Fortress is a Discord bot designed to enhance server interactions by providing various features and functionalities. It integrates with the Discord API to manage messages, commands, and user interactions seamlessly. | ||
|
||
- Create bot in discord | ||
- Add bot to server with admin permissions + message content intend | ||
- Add .env file from example .env.example | ||
- Fill in .env file with bot token | ||
- Start: | ||
## Features | ||
- Health check endpoint to monitor the bot's status. | ||
- Message history management with garbage collection. | ||
- Modular architecture for easy extensibility. | ||
|
||
``` | ||
make dev | ||
``` | ||
## Getting Started | ||
|
||
### Prerequisites | ||
- Go 1.16 or later | ||
- A Discord account to create a bot | ||
|
||
### Steps to Set Up | ||
|
||
1. Create a bot in Discord. | ||
2. Add the bot to your server with admin permissions and message content intent. | ||
3. Copy the `.env.example` file to `.env`. | ||
4. Fill in the `.env` file with your bot token. | ||
5. Start the bot: | ||
|
||
```bash | ||
make dev | ||
``` | ||
|
||
## Directory Structure | ||
|
||
- `cmd/`: Contains the entry point for the application. | ||
- `pkg/`: Contains the core functionality, including: | ||
- `adapter/`: Adapters for various services. | ||
- `discord/`: Discord-related functionalities, including services and views. | ||
- `config/`: Configuration management. | ||
- `logger/`: Logging utilities. | ||
- `.env.example`: Example environment configuration file. | ||
- `Makefile`: Build and run commands. |