https://github.com/Teeskins/teedata-discord-bot

🚤 Teedata Discord bot
https://github.com/Teeskins/teedata-discord-bot

nodejs skinstw teeworlds teeworldsdata

Last synced: 3 months ago
JSON representation

🚤 Teedata Discord bot

• Host: GitHub
• URL: https://github.com/Teeskins/teedata-discord-bot
• Owner: Teeskins
• License: mit
• Created: 2022-10-02T23:50:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-12T12:38:35.000Z (8 months ago)
• Last Synced: 2024-07-30T20:51:11.327Z (6 months ago)
• Topics: nodejs, skinstw, teeworlds, teeworldsdata
• Language: TypeScript
• Homepage:
• Size: 1.33 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🚤 teedata-discord-bot

![build](https://github.com/Teeskins/teedata-discord-bot/actions/workflows/build.yml/badge.svg)

## 📖 Build and run

You only need one of the following requirements:

- [NodeJS](https://nodejs.org/en/download)

  - 18.x

  - 20.x

### Environment variables

This is a description of the needed environment variable for the application at runtime, at least, for the "initialization" step.

| Name | Description | Mandatory |

| -- | -- | -- |

| TOKEN | Discord Bot token | Yes |

| MONGO_URI | MongoDB URI connection (see the Docker Compose file for example) | Yes |

| MONGO_INITDB_ROOT_USERNAME | MongoDB root username | Yes |

| MONGO_INITDB_ROOT_PASSWORD | MongoDB root password | Yes |

| MONGO_DATABASE | MongoDB database name | No |

| LOG_DIR | Application logs directory | No |

### Standalone container

You can use the `Dockerfile` at the project root, but you will need a MongoDB isntance anyway.

The container will need the above environment variables.

### With Docker Compose

The production Docker Compose file uses a `.env` file, you can create one with the above environment variables.

The Docker Compose file need the following environment variables:

- `MONGO_INITDB_ROOT_USERNAME`

- `MONGO_INITDB_ROOT_PASSWORD`

If you want to build it for development, you can run:

```bash

docker compose -f docker-compose.dev.yml up -d

```

For production:

```bash

docker compose build

docker compose up -d

```

## 🤝 Contribute

If you want to help the project, you can follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md).