john-bot

Um bot de utilidades para o Discord

MPL-2.0 License

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

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

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.

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!.

Depois que seu bot foi criado, clique em Copy para copiar o token do 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`
    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

Entre em nosso servidor de suporte:  John Bot Server 

Autor

Pedro Henrique Lemes🚀

   

Licença

Este projeto esta sobe a licença Mozilla Public License 2.0.


Feito com ❤️ por Pedro Henrique 👋🏽 Entre em contato!

Badges
Extracted from project README
Commitizen-friendly Twitter Gmail Instagram Discord Rocketseat