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

https://github.com/pedrinslzx/john-bot

Um bot de utilidades para o Discord
https://github.com/pedrinslzx/john-bot

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

Last synced: 4 months ago
JSON representation

Um bot de utilidades para o Discord

Awesome Lists containing this project

README

        


John Bot



Travis Build 
GitHub issues 
GitHub top language 
GitHub Repo stars 
GitHub latest release 
Lib 
Bot Status 
GitHub license 
Support Server 
Uptime Robot ratio (7 days)
Commitizen Friendly

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
- [x] Help
- [x] Ping
- [x] Reply
- [x] Ideia
- Grupos
- [x] Musica
- [x] Play
- [ ] Pause
- [ ] Add
- [ ] Remove
- [x] Skip
- [ ] Go Back
- [x] Queue
- [x] Now
- [ ] Moderação
- [x] Kick
- [ ] Unkick
- [ ] Ban
- [ ] Unban
- [ ] Mute
- [ ] Unmute

Oque foi usado?

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

- **Base**
- [Node.js](https://nodejs.org/pt-br/)
- [MongoDB](https://mongodb.com/)
- **Bot**
- [discord.JS](http://npmjs.com/package/discord.JS)
- [@discordjs/opus](http://npmjs.com/package/@discordjs/opus)
- [yt-search](http://npmjs.com/package/yt-search)
- [ytdl-core-discord](http://npmjs.com/package/ytdl-core-discord)
- **Web**
- [react](http://npmjs.com/package/react)
- [react-dom](http://npmjs.com/package/react-dom)
- [styled-components](http://npmjs.com/package/styled-components)
- [@primer/components](http://npmjs.com/package/@primer/components)
- **API**
- [express](http://npmjs.com/package/express)
- [morgan](http://npmjs.com/package/morgan)
- [cors](http://npmjs.com/package/cors)
- [discord-oauth2](http://npmjs.com/package/discord-oauth2)
- [passport](http://npmjs.com/package/passport)
- [passport-local](http://npmjs.com/package/passport-local)
- [cookie](http://npmjs.com/package/cookie)
- [@hapi/iron](http://npmjs.com/package/@hapi/iron)
- **Shared**
- **CodeStyle**
- [eslint](http://npmjs.com/package/eslint)
- [prettier](http://npmjs.com/package/prettier)
- **Prod**
- [chalk](http://npmjs.com/package/chalk)
- [axios](http://npmjs.com/package/axios)
- [uuid](http://npmjs.com/package/uuid)
- [dotenv](http://npmjs.com/package/dotenv)
- [mongoose](http://npmjs.com/package/mongoose)
- [date-fns](http://npmjs.com/package/date-fns)
- **Dev**
- [typescript](http://npmjs.com/package/typescript)
- [nodemon](http://npmjs.com/package/nodemon)
- [sucrase](http://npmjs.com/package/sucrase)

Instalação

Pré-requisitos

Ferramentas

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
[**Git**](https://git-scm.com), [**Node.js**](https://nodejs.org/pt-br/), [**Yarn**](https://yarnpkg.com/). Além disto é bom ter um editor para trabalhar com o código como [**VSCode**](https://code.visualstudio.com/).

Tokens

Você também precisará de um token para o seu bot. Para conseguir um token, entre no [Portal do Desenvolvedor](https://discord.com/developers/applications) 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

```bash
# 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/

# 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

[![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen?style=flat-square)](http://commitizen.github.io/cz-cli/)

- 1. Faça um **fork** do projeto.
- 2. Crie uma nova branch com as suas alterações: `git checkout -b feature/my-feature`
- 3. 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.
- 4. Envie as suas alterações: `git push origin feature/my-feature`

Suporte

Entre em nosso servidor de suporte: [ John Bot Server ](https://discord.gg/7T44HpVVxK)

## Autor



Pedro Henrique Lemes🚀

[![Twitter]](https://twitter.com/pedrinho_lemes) [![Gmail]](mailto:[email protected]) [![Instagram]](https://www.instagram.com/pedrinho.lemes/)
[![Discord]](https://discordapp.com/users/700327812950786048) [![Rocketseat]](https://app.rocketseat.com.br/me/pedrinholemes)

## Licença

Este projeto esta sobe a licença [Mozilla Public License 2.0](./LICENSE).

---

Feito com ❤️ por Pedro Henrique 👋🏽 [Entre em contato!](https://discordapp.com/users/700327812950786048)

[twitter]: https://img.shields.io/badge/-@pedrinho_lemes-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/pedrinho_lemes
[gmail]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected]
[instagram]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=Instagram&logoColor=white&link=https://www.instagram.com/pedrinho.lemes/
[discord]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=Discord&logoColor=white&link=https://discordapp.com/users/700327812950786048
[rocketseat]: https://img.shields.io/badge/-@pedrinholemes-8257e6?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAGRSURBVHgB7ZiBTcMwEEV/mKAjhA1ggzIB3YBsQDeIN4ANygYRE3QEYAJng3aD405xVMs41FES55B40peVNK5/z3fnKsA/0yiQGSIqebCsT1br6b0oihZrIuZYluLssTZsohkw1wzNWXyLefFnHkrWF+sQeaRl3fP2npEbNlfTde6wBrIwpXFiHbMavVIMQ+yQCxeRMRjkgtLyzqdBLnixisZhqWvcWcxJ3p1oHCXmgr9s40zI+OJ+fe3dszSOeU8OuiR+LEqWxvGaum7ySSLGeNhgOi2fGrepD9+kPERdrsxijvWAJWCThsYjc96862WbMXUF8fGLIfmsdmMVzMtzUlBXsdLvbGBOIjVHGkw2eGA9uaj022egBTazd6bEaAltsKmtt61WoglNeBH0OS4VzaQ+GPAYXJ+dai1FUgVtpcTauNbS97fSqVERMcFVrI+ewnDR+lEUyERKkWwj91pogeL/9XRscdCUewy0ECkOAy1EisNAE0FDNtAGXV5fGGjE5Z+BRtjYTq05gXK+afrrfAMkwQ4y3On//AAAAABJRU5ErkJggg==&logoColor=white&link=https://app.rocketseat.com.br/me/pedrinholemes