@maestro-ai/mcp-server 1.1.0 → 2.0.0

package/dist/content/skills/specialist-documentacao-tecnica/resources/templates/readme-template.md

@@ -0,0 +1,462 @@
+# 🚀 [Nome do Projeto]
+
+> [Descrição curta e impactante do projeto em uma linha]
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)
+[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://github.com/usuario/projeto/actions)
+[![Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg)](coverage/)
+
+## 📋 Sumário
+
+- [🎯 Sobre](#-sobre)
+- [✨ Features](#-features)
+- [🛠️ Stack Tecnológica](#️-stack-tecnológica)
+- [🚀 Getting Started](#-getting-started)
+- [📁 Estrutura do Projeto](#-estrutura-do-projeto)
+- [🔧 Scripts Disponíveis](#-scripts-disponíveis)
+- [🔐 Variáveis de Ambiente](#-variáveis-de-ambiente)
+- [🧪 Testes](#-testes)
+- [📊 APIs](#-apis)
+- [🚀 Deploy](#-deploy)
+- [📝 Contribuição](#-contribuição)
+- [📄 Licença](#-licença)
+
+---
+
+## 🎯 Sobre
+
+[Descreva o projeto em 2-3 parágrafos. Explique o problema que resolve, para quem é destinado e qual o principal benefício.]
+
+### Problema Resolvido
+[ ] **Desafio:** [Descreva o problema principal]
+[ ] **Impacto:** [Qual o impacto negativo atual]
+[ ] **Solução:** [Como este projeto resolve]
+
+### Público-Alvo
+[ ] **Desenvolvedores:** [Se aplicável]
+[ ] **Usuários Finais:** [Se aplicável]
+[ ] **Empresas:** [Se aplicável]
+
+---
+
+## ✨ Features
+
+### 🌟 Principais
+- [ ] **[Feature 1]:** [Descrição breve e impactante]
+- [ ] **[Feature 2]:** [Descrição breve e impactante]
+- [ ] **[Feature 3]:** [Descrição breve e impactante]
+
+### 🔧 Técnicas
+- [ ] **Performance:** [Otimizações implementadas]
+- [ ] **Segurança:** [Medidas de segurança]
+- [ ] **Escalabilidade:** [Como escala]
+- [ ] **Acessibilidade:** [WCAG 2.1 AA compliance]
+
+### 🎨 UX/UI
+- [ ] **Design Responsivo:** [Adaptação a dispositivos]
+- [ ] **Dark Mode:** [Suporte a tema escuro]
+- [ ] **Internacionalização:** [Suporte a múltiplos idiomas]
+- [ ] **Componentes:** [Biblioteca de componentes]
+
+---
+
+## 🛠️ Stack Tecnológica
+
+### Frontend
+[ ] **Framework:** [Next.js|React|Vue|Angular]
+[ ] **Linguagem:** [TypeScript|JavaScript]
+[ ] **Estilização:** [Tailwind CSS|Styled Components|Sass]
+[ ] **Estado:** [Redux|Zustand|Context API|Pinia]
+[ ] **Componentes:** [Shadcn/ui|Material-UI|Ant Design]
+[ ] **Testes:** [Jest|Vitest|Cypress|Playwright]
+
+### Backend
+[ ] **Framework:** [Node.js|Express|Fastify|Nest.js]
+[ ] **Linguagem:** [TypeScript|JavaScript|Python|Go]
+[ ] **Banco de Dados:** [PostgreSQL|MySQL|MongoDB|Redis]
+[ ] **ORM:** [Prisma|TypeORM|Mongoose|Sequelize]
+[ ] **Autenticação:** [JWT|OAuth|Passport.js]
+[ ] **API:** [REST|GraphQL|gRPC]
+
+### Infraestrutura
+[ ] **Cloud:** [AWS|Azure|Google Cloud|Vercel]
+[ ] **Container:** [Docker|Kubernetes]
+[ ] **CI/CD:** [GitHub Actions|GitLab CI|Jenkins]
+[ ] **Monitoramento:** [Sentry|DataDog|New Relic]
+[ ] **CDN:** [Cloudflare|AWS CloudFront]
+
+---
+
+## 🚀 Getting Started
+
+### Pré-requisitos
+- **Node.js** [X.X.X] ou superior
+- **npm** [X.X.X] ou **yarn** [X.X.X]
+- **Docker** (opcional, para ambiente containerizado)
+- **Git** para controle de versão
+
+### Instalação
+
+```bash
+# Clone o repositório
+git clone https://github.com/[usuario]/[projeto].git
+cd [projeto]
+
+# Instale dependências
+npm install
+# ou
+yarn install
+
+# Configure variáveis de ambiente
+cp .env.example .env
+# Edite o arquivo .env com suas configurações
+
+# Execute migrações do banco (se aplicável)
+npm run migrate
+# ou
+yarn migrate
+
+# Inicie o servidor de desenvolvimento
+npm run dev
+# ou
+yarn dev
+```
+
+### Configuração Inicial
+
+1. **Variáveis de Ambiente**
+   ```bash
+   # .env
+   DATABASE_URL="postgresql://user:password@localhost:5432/dbname"
+   JWT_SECRET="your-secret-key"
+   API_BASE_URL="http://localhost:3000"
+   ```
+
+2. **Banco de Dados**
+   ```bash
+   # Criar banco
+   createdb [nome_do_banco]
+   
+   # Rodar migrações
+   npm run migrate
+   
+   # Popular com dados iniciais
+   npm run seed
+   ```
+
+3. **Acesso à Aplicação**
+   - **Frontend:** http://localhost:3000
+   - **API:** http://localhost:3000/api
+   - **Documentação:** http://localhost:3000/docs
+
+---
+
+## 📁 Estrutura do Projeto
+
+```
+[projeto]/
+├── 📁 public/                     # Arquivos estáticos
+│   ├── 🖼️ images/                # Imagens e ícones
+│   ├── 📄 favicon.ico            # Favicon
+│   └── 📄 robots.txt             # Robots.txt
+├── 📁 src/                        # Código fonte
+│   ├── 📁 components/            # Componentes React/Vue
+│   │   ├── 📁 ui/               # Componentes de UI genéricos
+│   │   │   ├── 📄 Button.tsx
+│   │   │   ├── 📄 Input.tsx
+│   │   │   └── 📄 Modal.tsx
+│   │   └── 📁 business/          # Componentes de negócio
+│   │       ├── 📄 UserProfile.tsx
+│   │       └── 📄 Dashboard.tsx
+│   ├── 📁 pages/                 # Páginas (Next.js) ou Views
+│   │   ├── 📄 index.tsx
+│   │   ├── 📄 about.tsx
+│   │   └── 📄 login.tsx
+│   ├── 📁 services/              # Serviços e APIs
+│   │   ├── 📄 api.ts            # Cliente HTTP
+│   │   ├── 📄 auth.ts           # Serviço de autenticação
+│   │   └── 📄 users.ts          # Serviço de usuários
+│   ├── 📁 utils/                 # Utilitários e helpers
+│   │   ├── 📄 format.ts         # Formatação de dados
+│   │   ├── 📄 validation.ts     # Validações
+│   │   └── 📄 constants.ts      # Constantes
+│   ├── 📁 types/                 # Tipos TypeScript
+│   │   ├── 📄 user.ts
+│   │   ├── 📄 api.ts
+│   │   └── 📄 index.ts
+│   ├── 📁 hooks/                 # Hooks personalizados
+│   │   ├── 📄 useAuth.ts
+│   │   └── 📄 useApi.ts
+│   ├── 📁 styles/                # Estilos globais
+│   │   ├── 📄 globals.css
+│   │   └── 📄 components.css
+│   ├── 📄 App.tsx               # Componente principal
+│   └── 📄 main.tsx              # Entry point
+├── 📁 docs/                       # Documentação
+│   ├── 📁 api/                   # Documentação da API
+│   ├── 📁 guides/                # Guias de uso
+│   └── 📄 README.md              # Este arquivo
+├── 📁 tests/                      # Testes
+│   ├── 📁 unit/                  # Testes unitários
+│   ├── 📁 integration/           # Testes de integração
+│   └── 📁 e2e/                   # Testes end-to-end
+├── 📁 scripts/                    # Scripts de automação
+│   ├── 📄 build.sh
+│   ├── 📄 deploy.sh
+│   └── 📄 backup.sh
+├── 📁 .github/                    # Configurações do GitHub
+│   └── 📁 workflows/             # GitHub Actions
+├── 📄 package.json                # Dependências e scripts
+├── 📄 tsconfig.json              # Configuração TypeScript
+├── 📄 tailwind.config.js         # Configuração Tailwind
+├── 📄 docker-compose.yml          # Docker Compose
+├── 📄 .env.example               # Exemplo de variáveis
+├── 📄 .gitignore                 # Arquivos ignorados
+└── 📄 LICENSE                    # Licença
+```
+
+---
+
+## 🔧 Scripts Disponíveis
+
+### 🚀 Desenvolvimento
+```bash
+npm run dev          # Servidor de desenvolvimento
+npm run build        # Build para produção
+npm run preview      # Preview do build
+npm run lint         # Análise de código ESLint
+npm run type-check   # Verificação de tipos TypeScript
+```
+
+### 🧪 Testes
+```bash
+npm test             # Executa todos os testes
+npm run test:unit    # Testes unitários
+npm run test:integration # Testes de integração
+npm run test:e2e     # Testes end-to-end
+npm run test:coverage # Cobertura de código
+npm run test:watch   # Testes em modo watch
+```
+
+### 🚀 Deploy
+```bash
+npm run deploy:dev   # Deploy para ambiente de dev
+npm run deploy:stg   # Deploy para staging
+npm run deploy:prod  # Deploy para produção
+npm run deploy:docs  # Deploy da documentação
+```
+
+### 🛠️ Utilitários
+```bash
+npm run format       # Formata código com Prettier
+npm run clean        # Limpa build e cache
+npm run migrate      # Roda migrações do banco
+npm run seed         # Popula banco com dados
+npm run backup       # Backup do banco
+```
+
+---
+
+## 🔐 Variáveis de Ambiente
+
+### Obrigatórias
+```bash
+# Database
+DATABASE_URL="postgresql://user:password@localhost:5432/dbname"
+
+# Authentication
+JWT_SECRET="your-super-secret-jwt-key"
+JWT_EXPIRES_IN="7d"
+
+# API
+API_BASE_URL="http://localhost:3000"
+API_PORT=3000
+
+# External Services
+REDIS_URL="redis://localhost:6379"
+SMTP_HOST="smtp.gmail.com"
+SMTP_PORT=587
+```
+
+### Opcionais
+```bash
+# Development
+NODE_ENV="development"
+DEBUG="app:*"
+
+# Features
+ENABLE_ANALYTICS=true
+ENABLE_LOGGING=true
+
+# Third-party
+GOOGLE_ANALYTICS_ID="GA-XXXXXXXXX"
+SENTRY_DSN="https://your-sentry-dsn"
+```
+
+### Como Configurar
+1. Copie o arquivo de exemplo:
+   ```bash
+   cp .env.example .env
+   ```
+
+2. Edite o arquivo `.env` com suas configurações
+
+3. Nunca commit o arquivo `.env` (já está no `.gitignore`)
+
+---
+
+## 🧪 Testes
+
+### Estratégia de Testes
+- **Unitários:** Testes de funções e componentes isolados
+- **Integração:** Testes de integração entre módulos
+- **E2E:** Testes de fluxos completos do usuário
+
+### Executando Testes
+```bash
+# Todos os testes
+npm test
+
+# Testes específicos
+npm test -- --grep "users"
+
+# Com cobertura
+npm run test:coverage
+
+# Em modo watch
+npm run test:watch
+```
+
+### Cobertura
+- **Target:** Mínimo 80% de cobertura
+- **Atual:** [95%] de cobertura
+- **Relatório:** `coverage/lcov-report/index.html`
+
+---
+
+## 📊 APIs
+
+### Endpoints Principais
+| Método | Endpoint | Descrição |
+|--------|----------|-----------|
+| GET | `/api/users` | Lista usuários |
+| POST | `/api/users` | Cria usuário |
+| GET | `/api/users/:id` | Detalhes do usuário |
+| PUT | `/api/users/:id` | Atualiza usuário |
+| DELETE | `/api/users/:id` | Remove usuário |
+
+### Autenticação
+```bash
+# Login
+curl -X POST http://localhost:3000/api/auth/login \
+  -H "Content-Type: application/json" \
+  -d '{"email":"user@example.com","password":"password"}'
+
+# Usuários autenticados
+curl -H "Authorization: Bearer <TOKEN>" \
+  http://localhost:3000/api/users
+```
+
+### Documentação Completa
+- **Swagger UI:** http://localhost:3000/docs
+- **OpenAPI Spec:** http://localhost:3000/docs/json
+
+---
+
+## 🚀 Deploy
+
+### Ambientes
+- **Development:** https://dev.exemplo.com
+- **Staging:** https://staging.exemplo.com
+- **Production:** https://exemplo.com
+
+### Processo de Deploy
+1. **Build:** `npm run build`
+2. **Testes:** `npm run test:ci`
+3. **Deploy:** `npm run deploy:prod`
+
+### Deploy Automático
+O deploy é automático via GitHub Actions nos seguintes casos:
+- Push para branch `main` → Production
+- Push para branch `develop` → Staging
+- Pull Request → Preview
+
+---
+
+## 📝 Contribuição
+
+### Como Contribuir
+1. **Fork** o repositório
+2. **Crie** uma branch para sua feature: `git checkout -b feature/nova-feature`
+3. **Commit** suas mudanças: `git commit -m 'Add: nova feature'`
+4. **Push** para a branch: `git push origin feature/nova-feature`
+5. **Abra** um Pull Request
+
+### Convenções de Commit
+- **feat:** Nova funcionalidade
+- **fix:** Bug fix
+- **docs:** Documentação
+- **style:** Formatação, estilo
+- **refactor:** Refatoração
+- **test:** Testes
+- **chore:** Build process, dependências
+
+### Code Review
+- Todos os PRs precisam de aprovação
+- Testes obrigatórios para novas features
+- Cobertura de teste não pode diminuir
+
+---
+
+## 📄 Licença
+
+Este projeto está licenciado sob a **MIT License** - veja o arquivo [LICENSE](LICENSE) para detalhes.
+
+---
+
+## 🤝 Agradecimentos
+
+- **[Nome 1]** - Por [contribuição]
+- **[Nome 2]** - Por [contribuição]
+- **Comunidade** - Por todo o suporte
+
+---
+
+## 📞 Contato
+
+- **Autor:** [Seu Nome]
+- **Email:** [seu.email@exemplo.com]
+- **Twitter:** [@seu_twitter]
+- **LinkedIn:** [seu-linkedin]
+
+---
+
+## 🗺️ Roadmap
+
+### v1.1 (Próximo)
+- [ ] [Feature 1]
+- [ ] [Feature 2]
+- [ ] Melhorias de performance
+
+### v2.0 (Futuro)
+- [ ] [Feature grande]
+- [ ] Redesign completo
+- [ ] API v2
+
+---
+
+## 📈 Estatísticas
+
+![GitHub stars](https://img.shields.io/github/stars/usuario/projeto?style=social)
+![GitHub forks](https://img.shields.io/github/forks/usuario/projeto?style=social)
+![GitHub issues](https://img.shields.io/github/issues/usuario/projeto)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/usuario/projeto)
+
+---
+
+**⭐ Se este projeto foi útil, deixe uma estrela!**
+
+---
+
+*Última atualização: [Data atual]*