[Nome do Projeto]
[Descrição curta - uma linha]
Quick Start
# Clonar
git clone [repo]
cd [projeto]
# Configurar
cp .env.example .env
# editar .env com suas credenciais
# Rodar
docker-compose up -d
# ou
[comando para rodar local]
Documentação
| Documento | Descrição |
|---|---|
| document_context.md | O que o projeto faz |
| technical_context.md | Como foi construído |
| CLAUDE.md | Rules para IA |
| ADRs | Decisões arquiteturais |
| Guidelines | Padrões de código |
Stack
- Backend: [Java Spring 3.5 | Python FastAPI | Node Express]
- Frontend: [Vue 3 | Angular 19 | Streamlit]
- Database: [PostgreSQL | MongoDB]
- Auth: Keycloak
Scripts
| Comando | Descrição |
|---|---|
[comando] |
Rodar em dev |
[comando] |
Rodar testes |
[comando] |
Build produção |
[comando] |
Lint |
Estrutura
[projeto]/
├── src/ # Código fonte
├── tests/ # Testes
├── docs/ # Documentação
├── infra/ # Docker, K8s
└── ...
Licença
[MIT | Proprietário | ...]