Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/typeofweb-org/typeofweb-discord-bot

bot discord-server hacktoberfest

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/typeofweb-org/typeofweb-discord-bot
Owner: typeofweb-org
License: agpl-3.0
Created: 2019-05-05T19:10:33.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-04-14T06:13:32.000Z (7 months ago)
Last Synced: 2024-05-08T01:53:45.558Z (6 months ago)
Topics: bot, discord-server, hacktoberfest
Language: TypeScript
Homepage:
Size: 1.54 MB
Stars: 18
Watchers: 2
Forks: 24
Open Issues: 15
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Type of Web Discord Bot

[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors-)

## Getting Started

#### Prepare project

Run `yarn` to install all dependencies

_[Based on windows system]_

If an error with Python occurs open the system console with admin privileges and type:

```
yarn --add-python-to-path='true' --debug install --global windows-build-tools
```

If that was the case run again `yarn` to install dependencies properly.

#### Setup environmental variables

Create `.env.dev` file based on `.env.dev-sample` (just copy and rename it). Fill the API keys with `0` if you don't have them.

#### Connect to development bot

Create a new discord server where you will be testing your bot.

[Follow this tutorial to create a new bot.](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) Then add it to your server.

Use the bot token in `.env.dev` file.

#### Run the server

Use `yarn dev` to start the server.

You should get this in your console, which suggests that everything went ok.

```
Server running!
Logged in as [Bot Name]!
```

_You will probably get some errors like "Failed to connect to database" as well. Don't worry about them if you don't need the database._

When you log into the discord server you should see that your Bot is active.
You can use one of the existing commands like `!co` to try it out :)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Michał Miszczyszyn}
💻 🤔 🚇 👀

_Deeadline
💻 🤔

_przytrzask
💻 🤔

_nanoDW
💻 🤔

_Secrus
💻 🤔 📖

_larto42
📖

_jkonieczny
💻 🤔 ⚠️ 🛡️

_{Kuba Domański}
💻

_Survikrowa
💻 🤔

_{Adam Siekierski}
💻 🤔

_{Olaf Sulich}
💻

_{Jakub Wąsik}
💻

_{Jakub Kisielewski}
💻

_{Bartosz Dryl}
💻

_{Łukasz Dymek}
💻

_kamiloox
💻

_{Bartosz Zagrodzki}
💻 📖

_{Michał Michalczuk}
💻 🐛

_{Adrian Polak}
💻

_{Karol Syta}
💻 🤔