TemplatesProject
{{NOMEDOPROJETO}}
{{DESCRICAOCURTA}}
2 min de leitura
Template pronto para copiar ou baixar
{{DESCRICAO_CURTA}}
Sobre
{{SOBRE_O_PROJETO}}
Contexto de negócio: PROJECT_CONTEXT.md
Stack
- Linguagem/Framework: {{LINGUAGEM_FRAMEWORK}}
- Banco de dados: {{BANCO_DE_DADOS}}
- Infraestrutura: {{INFRAESTRUTURA}}
- Outros: {{OUTROS_SERVICOS}}
Pré-requisitos
- {{PRE_REQUISITO_1}}
- {{PRE_REQUISITO_2}}
Como rodar localmente
# 1. Clone o repositório
git clone {{URL_DO_REPOSITORIO}}
cd {{NOME_DO_PROJETO}}
# 2. Configure as variáveis de ambiente
cp .env.example .env
# preencha os valores em .env
# 3. Suba o projeto
{{COMANDO_PARA_RODAR}}Detalhes das variáveis: docs/ENVIRONMENT.md
Testes
{{COMANDO_DE_TESTES}}Documentação
| Documento | Conteúdo |
|---|---|
PROJECT_CONTEXT.md | Contexto de negócio e do problema. |
CLAUDE.md | Regras para a IA atuar no repositório. |
docs/PRD.md | Requisitos do produto. |
docs/ARCHITECTURE.md | Arquitetura e decisões estruturais. |
docs/API.md | Endpoints, contratos e exemplos. |
docs/DATABASE.md | Modelo de dados e relações. |
docs/DEPLOY.md | Processo de publicação. |
docs/ENVIRONMENT.md | Variáveis de ambiente. |
docs/DECISIONS.md | Registro de decisões técnicas. |
docs/CHANGELOG.md | Histórico de mudanças por versão. |
Deploy
{{RESUMO_DEPLOY}}
Processo completo: docs/DEPLOY.md