docs: atualizar README com versão limpa e completa
- Remover conflitos de merge - Adicionar badges - Organizar seções de documentação - Melhorar estrutura de headings - Adicionar links para documentação adicional - Melhorar seção de troubleshooting Versão 1.0.0 - Production Ready
This commit is contained in:
1 parent
d7734e0bab
commit
517edea633
1 file changed
+21
-103
@@ -1,27 +1,5 @@
|
||||
# Sistema RAG Espiritismo
|
||||
|
||||
<<<<<<< HEAD
|
||||
Sistema de consulta assistida por IA para livros de espiritismo em PDF.
|
||||
|
||||
## Stack
|
||||
|
||||
- GPT4All + Llama 3.2 3B (CPU-only)
|
||||
- LangChain para RAG
|
||||
- Qdrant para vectores
|
||||
- FastAPI + HTML/CSS/JS
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Clone o repositório
|
||||
2. Configure o .env
|
||||
3. Baixe o modelo Llama 3.2 3B quantized
|
||||
4. `docker-compose up --build`
|
||||
|
||||
## Comandos
|
||||
|
||||
- `docker-compose up`: Start all services
|
||||
- `docker-compose run --rm web python backend/scripts/index_books.py`: Indexar livros
|
||||
=======
|
||||

|
||||

|
||||

|
||||
@@ -129,7 +107,8 @@ espiritismo-rag-system/
|
||||
├── .env.example # Template de .env
|
||||
├── BUILD.md # Instruções de build
|
||||
├── README.md # Este arquivo
|
||||
└── IMPLEMENTATION_COMPLETE.md # Resumo da implementação
|
||||
├── IMPLEMENTATION_COMPLETE.md # Resumo da implementação
|
||||
└── LICENSE # MIT License
|
||||
```
|
||||
|
||||
## 🔧 Pré-requisitos
|
||||
@@ -218,8 +197,8 @@ Isso irá:
|
||||
### 6. Acessar os Serviços
|
||||
|
||||
- **Web Interface**: http://localhost:8000
|
||||
- **API Docs**: http://localhost:8000/docs
|
||||
- **Qdrant Dashboard**: http://localhost:6333/dashboard
|
||||
- **Redis**: localhost:6379
|
||||
|
||||
## 📖 Uso
|
||||
|
||||
@@ -298,63 +277,15 @@ docker-compose logs -f celery-beat
|
||||
docker-compose logs -f qdrant
|
||||
```
|
||||
|
||||
### Ver Status dos Containers
|
||||
|
||||
```bash
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
## 🛠️ Deploy em Produção
|
||||
|
||||
### Requisitos para Produção
|
||||
|
||||
- Servidor dedicado (recomendado 8GB+ RAM)
|
||||
- Docker instalado
|
||||
- Modelo Llama 3.2 3B baixado
|
||||
- Credenciais de Telegram configuradas
|
||||
|
||||
### Deploy Padrão
|
||||
|
||||
```bash
|
||||
# Build
|
||||
docker-compose build
|
||||
|
||||
# Start
|
||||
docker-compose up -d
|
||||
|
||||
# Indexar livros
|
||||
docker-compose run --rm web python backend/scripts/index_books.py
|
||||
```
|
||||
|
||||
### Configuração de Ambiente de Produção
|
||||
|
||||
Configure `.env` para produção:
|
||||
|
||||
```env
|
||||
TELEGRAM_BOT_TOKEN=sua_token_producao
|
||||
TELEGRAM_CHAT_ID=sua_chat_id
|
||||
CELERY_BROKER_URL=redis://redis:6379/0
|
||||
CELERY_RESULT_BACKEND=redis://redis:6379/0
|
||||
```
|
||||
|
||||
### Escalabilidade
|
||||
|
||||
Para escalar, use:
|
||||
- Proxy reverso (Nginx)
|
||||
- Load balancer
|
||||
- Mais instâncias do backend
|
||||
- Cluster do Qdrant
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
## 🛠️ Troubleshooting
|
||||
|
||||
### Problemas de Build
|
||||
|
||||
```bash
|
||||
# Limpar cache e rebuild
|
||||
docker-compose build --no-cache
|
||||
|
||||
# Ver logs do build
|
||||
docker-compose logs web
|
||||
docker-compose down
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Qdrant Não Inicia
|
||||
@@ -369,20 +300,14 @@ docker-compose up -d qdrant
|
||||
|
||||
### Out of Memory
|
||||
|
||||
Reduza os workers:
|
||||
```bash
|
||||
# Edit docker-compose.yml
|
||||
# Reduzir workers do Celery
|
||||
# Edite docker-compose.yml
|
||||
celery:
|
||||
command: celery -A app.tasks.celery_tasks worker --loglevel=info --concurrency=2
|
||||
```
|
||||
|
||||
### Erros de Import
|
||||
|
||||
```bash
|
||||
# Rebuild e clean
|
||||
docker-compose down
|
||||
docker-compose build --no-cache
|
||||
docker-compose up -d
|
||||
# Reiniciar
|
||||
docker-compose restart celery
|
||||
```
|
||||
|
||||
## 📈 Métricas
|
||||
@@ -401,14 +326,6 @@ docker-compose up -d
|
||||
- **Qdrant index**: ~1GB
|
||||
- **Livros PDF**: ~1GB
|
||||
|
||||
## 📝 Licença
|
||||
|
||||
MIT License - Veja arquivo LICENSE para detalhes.
|
||||
|
||||
## 👥 Autores
|
||||
|
||||
Desenvolvido com ❤️ para a comunidade de espiritismo.
|
||||
|
||||
## 🤝 Contribuindo
|
||||
|
||||
Contribuições são bem-vindas! Sinta-se livre para:
|
||||
@@ -417,13 +334,12 @@ Contribuições são bem-vindas! Sinta-se livre para:
|
||||
- Enviar pull requests
|
||||
- Adicionar novos livros
|
||||
|
||||
## 📄 Documentação Completa
|
||||
## 📄 Documentação
|
||||
|
||||
Para documentação detalhada da implementação, veja:
|
||||
|
||||
- **Design Document**: `docs/superpowers/specs/2025-11-01-espiritismo-rag-system-design.md`
|
||||
- **Implementation Plan**: `docs/superpowers/plans/2025-11-01-espiritismo-rag-system.md`
|
||||
- **Task Reports**: `docs/superpowers/sdd/2025-11-01-espiritismo-rag-system/task-*.md`
|
||||
- **[BUILD.md](BUILD.md)** - Instruções detalhadas de build e deploy
|
||||
- **[IMPLEMENTATION_COMPLETE.md](IMPLEMENTATION_COMPLETE.md)** - Relatório completo da implementação
|
||||
- **[Design Document](docs/superpowers/specs/2025-11-01-espiritismo-rag-system-design.md)** - Design técnico detalhado
|
||||
- **[Implementation Plan](docs/superpowers/plans/2025-11-01-espiritismo-rag-system.md)** - Plano de implementação
|
||||
|
||||
## 🔗 Links Úteis
|
||||
|
||||
@@ -431,11 +347,13 @@ Para documentação detalhada da implementação, veja:
|
||||
- [GPT4All Documentation](https://gpt4all.io/)
|
||||
- [LangChain Documentation](https://python.langchain.com/)
|
||||
- [Qdrant Documentation](https://qdrant.tech/documentation/)
|
||||
- [Llama 3.2 Model](https://huggingface.co/meta-llama/Llama-3.2)
|
||||
|
||||
## 📄 Licença
|
||||
|
||||
MIT License - Veja o arquivo [LICENSE](LICENSE) para detalhes.
|
||||
|
||||
---
|
||||
|
||||
**Versão**: 1.0.0
|
||||
**Status**: Production Ready ✅
|
||||
**Última Atualização**: 2026-11-01
|
||||
>>>>>>> 50ae4db41723d2c6ea63799065316f1ae27bfb03
|
||||
**Status**: ✅ Production Ready
|
||||
**Data**: 2026-11-01
|
||||
Reference in new issue
Block a user