Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tiago154/discord-bot-guilda-nodejs

🤖 - Exemplo prático de como criar um bot no discord
https://github.com/tiago154/discord-bot-guilda-nodejs

bot discord discord-bot discord-js nodejs-bot

Last synced: 20 days ago
JSON representation

🤖 - Exemplo prático de como criar um bot no discord

Awesome Lists containing this project

README

        



Bot logo

Bombril bot - Mil e uma utilidades

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/tiago154/discord-bot-guilda-nodejs.svg)](https://github.com/tiago154/discord-bot-guilda-nodejs/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/tiago154/discord-bot-guilda-nodejs.svg)](https://github.com/tiago154/discord-bot-guilda-nodejs/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

---

🤖 - Bot desenvolvido na Guilda de Nodejs exemplificando alguns recursos na plataforma do Discord


❓ - A ideia é que cada desenvolvedor deixe online sua própria versão do bot. Os passos para isso serão descritos abaixo.


## 📝 - Conteúdo

- [Sobre](#about)
- [Demonstração](#demo)
- [Como funciona](#working)
- [Uso](#usage)
- [Utilizando](#getting_started)
- [Construído usando](#built_using)
- [Contrubuindo](../CONTRIBUTING.md)
- [Autores](#authors)

## 🧐 - Sobre

Bombril bot é responsável por ajudar seus usuários em diversas tarefas (mil e uma utilidade).

Atualmente possui as funcionalidades:

- Informações de localidade pelo CEP
- Dados relacionados ao COVID-19 por país

## 🎥 - Demonstração

![demo-bombril](https://user-images.githubusercontent.com/10531605/84601614-df4d6300-ae57-11ea-8f81-64de81080ac7.gif)

## 💭 - Como funciona

- CEP:

O bot consulta uma API publica de CEP (https://docs.awesomeapi.com.br/api-cep), filtra os dados relevantes e monta uma mensagem amigável para o usuário. Também é montado a URL do Google Maps com a localidade aproximada.

- COVID:

O bot consulta uma API publica do COVID-19 (https://github.com/NOVELCOVID/API), filtra os dados relevantes e monta uma mensagem amigável para o usuário. Também é montado a URL da busca do Google onde é mostrado alguns dados do país

O Bot inteiro é escrito em Nodejs 12

## 🎈 - Uso

Para usar o bot digite:

- CEP:

```
!bombril cep:
```
O cep pode ser escrito com 8 digitos ou 5 digitos + 3 digitos separados por `-`

- Covid:

Para usar o bot digite:

```
!bombril covid:
```

O país tem que ser escrito em ingles exemplo: `Brazil` ou utilizar o padrão `ISO 3166-1` com o código de 2 (`BR`) ou 3 (`BRA`) caracteres.

## 🏁 - Utilizando

### Ideia

A ideia é que o desenvolvedor suba sua própria versão do BOT

### Pré-requisitos

Para rodar o bot será necessário:

- Ser administrador em um servidor discord
- Ter o Nodejs 12 instalado
- Criar seu bot no [painel do discord](https://discord.com/developers/applications)

### Criando seu BOT no Discord

Acesse https://discord.com/developers/applications e crie sua aplicação responsável pelo BOT

![discord-applications](https://user-images.githubusercontent.com/10531605/85205402-9bdc7400-b2f1-11ea-8178-7437022a41cb.png)



Depois disso, adicione seu bot

![image](https://user-images.githubusercontent.com/10531605/85205465-e65df080-b2f1-11ea-8d34-bfaac30126e4.png)

Autorize o bot em seu servidor.

A URL para integração pode ser gerada no link `https://discord.com/developers/applications/{CLIENT_ID}/oauth2`.

![generate-integration-url](https://user-images.githubusercontent.com/10531605/85205615-d397eb80-b2f2-11ea-9df9-20b337292bbd.png)

### Instalando

Clone o repositório

```sh
git clone [email protected]:tiago154/discord-bot-guilda-nodejs.git

cd discord-bot-guilda-nodejs
```

Agora instale as dependências

```sh
npm install
```

Não esqueça de preencher o arquivo `.env` com o token do BOT (https://discordjs.guide/preparations/setting-up-a-bot-application.html#your-token) e outras variaveis de ambiente. O exemplo de quais valores deve ser preenchido está disponivel no arquivo `.env_example`.

Para iniciar o bot, digite:

```js
npm start
```

ou para auto reload

```js
npm run dev
```

## ⛏️ - Construído usando

- [Discord.js](https://discord.js.org/#/) - O Discord.js é um poderoso módulo node.js que permite interagir com a API do Discord com muita facilidade
- [Axios](https://www.npmjs.com/package/axios) - Cliente HTTP baseado em Promise para o navegador e node.js

## ✍️ - Autores

- [@tiago154](https://github.com/tiago154) - Construção da ideia e trabalho inicial

Veja também a lista de [contribuidores](https://github.com/tiago154/discord-bot-guilda-nodejs/contributors) que participaram deste projeto.