Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonstnn/mybot
Discord bot
https://github.com/simonstnn/mybot
discord discord-api discord-bot discord-js dont-break-the-chain mongodb nodejs typescript
Last synced: 13 days ago
JSON representation
Discord bot
- Host: GitHub
- URL: https://github.com/simonstnn/mybot
- Owner: SimonStnn
- Created: 2022-09-21T18:20:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-22T07:53:27.000Z (5 months ago)
- Last Synced: 2024-06-22T17:51:25.836Z (5 months ago)
- Topics: discord, discord-api, discord-bot, discord-js, dont-break-the-chain, mongodb, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 354 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MyBot
A Discord bot.
---
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
---
## Features
- Slash commands
- Dont break the chain. A word in a channel has to be repeated. Scores are stored in database.
## Technologies Used
- [Node.js](https://nodejs.org/)
- [discord.js](https://discord.js.org/)
- [MongoDB](https://www.mongodb.com/)
## Contributing
If you'd like to contribute to this project, please open an issue or submit a pull request with your proposed changes. I welcome any contributions or improvements!
Here are the steps to make contributions:
1. Fork the repository.
1. Create a new branch for your feature or bug fix.
1. Make your changes and commit them.
1. Push your branch to your fork.
1. Create a pull request to the main repository.
### Getting Started
What you first need to do are the steps mentioned in [discordjs](https://discordjs.guide/preparations/) to set up a discord bot. Add it to your server. Now you're done setting up the bot.
To run this project locally, follow these steps:
1. Clone the Repository:
```bash
git clone https://github.com/SimonStnn/MyBot.git
cd website
```
2. Install Dependencies:
```bash
npm install
```
3. Make `.env` from [.env.template](.env.template) and put in tokens and keys.
4. Run the Development Server:
```bash
tsc --project ./tsconfig.json
npm run dev
```
Now the bot should be online.
> You can also start a debug session with vs-code.
## Deploying with docker
To deploy the bot in docker, simply make the `.env` file from [``.env.template``](.env.template), put in the the required values and run:
```bash
docker-compose up -d
```
### Configuration
You should also update the `src/config.json` to match your values.