whoisdon / CommunityStructure

Psst! Ready for an exciting adventure? Dive into my README! It's not just a bunch of text; it's an amazing guide to understanding the project. Trust me, it's worth the read!

🔐 CommunityStructure.

Projeto   |    Como usar   |    Licença

📋 Projeto

• 🔐 A estrutura do discord.js permite criar bots e interagir com o Discord, com objetos que representam servidores, canais, mensagens, entre outros. Há métodos e eventos disponíveis para manipular esses objetos e responder a ações do usuário. Conhecer bem a estrutura é importante para aproveitar ao máximo as capacidades do discord.js e criar soluções personalizadas.
  

💻 Como usar

Para clonar e rodar essa aplicação você precisará do Git e Node.js.
Na sua linha de comando:

# Clone esse repositório
$ git clone https://github.com/whoisdon/CommunityStructure.git

# Vá para o repositório Back-end
$ cd CommunityStructure

# Instale as dependencias
$ npm install

# Instale as dependencias globalmente  
$ npm install -g

⚙️ Configuração

Utilizando shell para criação e manipulação de variáveis de ambiente:

# Criando arquivo .env
touch .env

Dentro do arquivo .env iremos armazenar algumas variáveis:

TOKEN=
MONGODB_URL=

✰ Iniciar Projeto

Você pode dar início ao projeto com facilidade, utilizando diretamente o comando:

node .

Você pode dar início ao projeto usando o nodemon, garantindo assim uma atualização em tempo real dos seus avanços.

npm run dev

📦 CLI

Alguns comandos CLI foram pré definidos para ajudar e auxiliar na estilização do código.

CLI pré definidos:

Command	Result
$ beautify	padroniza o código fonte, tornando-o mais legível e fácil de manter.
$ prettierrc	formatação de código, para padronizar e aprimorar a aparência do seu código.
$ eslintrc	verifica e corrigi problemas de padrão e estilo no seu código de maneira automatizada.

🏗️ Estrutura

Exemplo de implementação de comandos slash (/) no Discord, usando a base padrão do repositório.

const Commands = require('../../Handlers/commands');

module.exports = class extends Commands {
	constructor(client) {
	  super(client, {
            name: 'nome',
            description: 'descrição',
 });
}

run(interaction) {

 }
}

Exemplo de implementação de comandos slash (/) no Discord, usando a classe SlashCommandBuilder como base.

const Commands = require('../../Handlers/commands');
const { SlashCommandBuilder } = require('discord.js')

module.exports = class extends Commands {
	constructor(client) {
	  super(client, {
	    data: new SlashCommandBuilder()
            .setName('nome')
            .setDescription('descrição'),
 });
}

run(interaction) {

 }
}

📝 License

Este projeto está sob a licença Apache. Consulte o LICENSE para obter detalhes.

---

Feito por Who Am I#0001 e Juaum • 愛#4009 👋

Discord Don: Entre em contato comigo! Github Don: github.com/whoisdon  

Discord Juaum: Entre em contato com Juaum! Github Juaum: github.com/joaolumertz