Marvin - bot oficial da comunidade Nucleo 42

• Marvin - bot oficial da comunidade Nucleo 42
  • Referência
  • Como contribuir
    • Importante
    • Passo a passo para contribuir:
  • Rodando localmente
    • Antes de começar
    • Iniciando o projeto
    • Testando localmente
  • Suporte
  • Feedback
  • Contribuidores

Referência

• discord.js - lib for discord api
• Discord Developer Portal
• Drizzle ORM - next gen TypeScript ORM
• node-canvas- Canvas implementation for Node.js

Como contribuir

Importante

• Antes de começa a contribuir, leia a documentação da estrutura clicando aqui.

Passo a passo para contribuir:

1. Crie um fork deste repositório.
2. Envie seus commits em inglês.
3. Marque as #issues relacionada com seu PR.
4. Antes de enviar seu Pull Request, é essencial manter sua branch local atualizada para evitar conflitos. Saiba Mais.
   • Para fazer isso:
   • Na página inicial do seu Fork no GitHub, localize o botão Sync fork para sincronizar seu repositório com as atualizações do repositório oficial.
   • Em seguida, execute o seguinte comando no seu terminal: git pull <repositorio> <branch>.
5. Faça um buildda aplicação e teste localmente antes de abrir um PR
6. Solicite um pull request na branch develop.
   • Preencha todas as informações do template e envie.

Rodando localmente

Antes de começar

• pegue seu token do discord em: https://discord.com/developers/docs/quick-start/getting-started#step-1-creating-an-app
• inicie seu banco de dados postgres localmente ou use compose: docker-compose.yml
• crie um arquivo .envna raiz do projeto com os valores preenchido baseado no .env.example

Iniciando o projeto

Clone o projeto

  git clone https://github.com/Nucleo42/marvin-bot.git

Entre no diretório do projeto

  cd marvin-bot

Instale as dependências

  yarn 

Rode as migrate do banco de dados

  yarn  migration

Inicie a aplicação

  yarn  dev

Testando localmente

Faça o build da aplicação com

  yarn  build

Inicie a aplicação

  yarn  start

Suporte

• Entre na nossa comunidade do discord para duvidas e suporte
• https://discord.gg/wKDGnsUQge

Feedback

Se você tiver algum feedback, por favor nos deixe saber por meio de issues nesse repositório

Contribuidores ✨

Um agradecimento a todos!!(emoji key):

Gustavo Parlandim 🚧

Este projeto segue contribuições de all-contributors. contribuições de qualquer tipo bem-vindas!