pedrinslzx / john-bot Goto Github PK

View Code? Open in Web Editor NEW

9.0 1.0 0.0 1.4 MB

Um bot de utilidades para o Discord

Home Page: https://discord.gg/7T44HpVVxK

License: Mozilla Public License 2.0

Shell 0.80% JavaScript 0.30% TypeScript 98.90%

discord-bot discord-js discord-js-bot discord bot moderation-bot moderation utility utility-bot fun

john-bot's Introduction

John Bot

Um bot de utilidades para seu servidor no Discord

🚧 Projeto em beta... 🚧

Tópicos

Objetivo • Roadmap • Tecnologias • Contribuição • Instalação • Suporte • Licença

Roadmap

Comandos
- Help
- Ping
- Reply
- Ideia
Grupos
- Musica
  - Play
  - Pause
  - Add
  - Remove
  - Skip
  - Go Back
  - Queue
  - Now
- Moderação
  - Kick
  - Unkick
  - Ban
  - Unban
  - Mute
  - Unmute

Oque foi usado?

As seguintes ferramentas foram usadas na construção do projeto:

Base
- Node.js
- MongoDB
Bot
Web
API
- express
- morgan
- cors
- discord-oauth2
- passport
- passport-local
- cookie
- @hapi/iron
Shared
- CodeStyle
  - eslint
  - prettier
- Prod
  - chalk
  - axios
  - uuid
  - dotenv
  - mongoose
  - date-fns
- Dev

Instalação

Pré-requisitos

Ferramentas

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Yarn. Além disto é bom ter um editor para trabalhar com o código como VSCode.

Tokens

Você também precisará de um token para o seu bot. Para conseguir um token, entre no Portal do Desenvolvedor no site oficial do Discord, selecione uma aplicação - se necessário crie uma clicando no botão New Application - então clique em Bot, se necessário clique em Add Bot e confirme que deseja criar um Bot em Yes, do it!.

⚠️ Não se esqueça que essa ação é irreversível, se você criar o Bot, não tem como exclui-lo, a não ser o App por completo. ⚠️

Depois que seu bot foi criado, clique em Copy para copiar o token do seu Bot.

⚠️ O token é particular de cada Bot, com ele é possível logar como seu Bot utilizando libs de conexão com a Discord Bot API, sendo ela via JDA no Java, discord.py no Python, Discord.JS no JavaScript ou Typescript, entre outras. Se por um acaso você vazou ele, clique em Regenerate para gerar outro token e em Copy para copia-lo. ⚠️

Iniciando o seu Bot

# Clone este repositório
$ git clone https://github.com/pedrinholemes/john-bot.git -b master
# para dev troque: master -> dev

# Acesse a pasta do projeto no terminal
$ cd john-bot

# Instale as dependências
$ yarn install

# Entre na pasta desejada
$ cd packages/<bot | web | api>

# Copie o template de variáveis ambiente
$ cp .env.example .env

# E popule o `.env` com os valores desejados:
# - Vim
$ vim .env
# - VSCode - abra o Vscode na pasta do projeto e edite o `.env`
$ code .

# Execute a aplicação
# Em modo de desenvolvimento
$ yarn dev

# Ou em modo de produção
# Se for WEB execute:
$ yarn build && yarn start
# senão simplesmente:
$ yarn start

# Veja os logs para entender oque o package esta fazendo:
# Bot: estará logado automaticamente sem um servidor HTTP
# Web: estará disponível em seu `localhost:3000`
# API: estará disponível em seu `localhost:3333/api`

Como contribuir para o projeto

1. Faça um fork do projeto.
1. Crie uma nova branch com as suas alterações: git checkout -b feature/my-feature
1. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit
- 3.1. Espere o lint-staged fazer o lint dos arquivos.
- 3.2. Selecione as configurações desejadas para o commit.
- 3.3. Espere o commit-lint fazer o lint do seu commit.
1. Envie as suas alterações: git push origin feature/my-feature