Skip to content

Home

Jump to bottom
Eldritch Tenebris edited this page Mar 3, 2025 · 20 revisions

Documentação Base TypeScript

📁 Estrutura de Pastas

A estrutura de pastas do projeto é organizada da seguinte forma:

.
├── .vscode/                  # Configurações do VS Code
│   ├── extensions.json      # Extensões recomendadas
│   ├── settings.json        # Configurações do editor
│   └── snippets.json        # Snippets personalizados
│
├── src/                     # Código fonte
│   ├── database/           # Configuração do banco de dados
│   │   ├── schemas/        # Schemas do MongoDB
│   │   └── index.ts        # Conexão com o banco
│   │
│   ├── discord/            # Módulos do bot
│   │   ├── base/          # Classes e utilitários base
│   │   ├── commands/      # Comandos do bot
│   │   ├── events/        # Eventos do Discord
│   │   └── responders/    # Handlers de interações
│   │
│   ├── functions/         # Funções utilitárias
│   ├── settings/          # Configurações do projeto
│   └── index.ts           # Ponto de entrada
│
├── .env                    # Variáveis de ambiente
├── .env.example           # Exemplo de variáveis
├── package.json           # Dependências e scripts
├── settings.json          # Configurações globais
└── tsconfig.json          # Configuração TypeScript

📦 Principais Diretórios

  • commands/ - Comandos slash e de contexto
  • events/ - Listeners de eventos do Discord
  • responders/ - Handlers de botões e menus
  • database/ - Configuração e schemas do MongoDB
  • settings/ - Configurações globais e ambiente

🔧 Arquivos de Configuração

  • .env - Variáveis de ambiente (tokens, URLs)
  • settings.json - Configurações globais (cores, emojis)
  • tsconfig.json - Configuração do TypeScript
  • package.json - Dependências e scripts NPM

📚 Instalação e Inicialização

Requisitos

  • Node.js instalado
  • NPM instalado
  • GitHub instalado

Windows & Linux

  1. Crie uma pasta para o projeto e acesse-a:

    mkdir Base-Typescript-Development && cd Base-Typescript-Development

  2. Abra o VS Code na pasta do projeto:

    code .

  3. No terminal do VS Code, execute o seguinte comando para iniciar o projeto:

    npx neon-ts@latest

🚀 Inicialização e Desenvolvimento

Desenvolvimento

Para iniciar o projeto em modo desenvolvimento:

npm install
npm run dev

Compilação

Para compilar o projeto para produção:

npm run build

O código compilado será gerado na pasta build/.

Produção

Para iniciar o projeto compilado:

npm start

💾 Banco de Dados (MongoDB)

Configure a URI no arquivo .env:

MONGO_URI=mongodb+srv://<user>:<password>@<database>.mongodb.net

⚡ Scripts Disponíveis

# Desenvolvimento
npm run dev         # Inicia com .env
npm run dev:dev    # Inicia com .env.dev

# Produção
npm run build      # Compila TypeScript
npm start         # Inicia versão compilada

🔗 Links Úteis

Clone this wiki locally