Imobiliária Bortone — Documentação
Bem-vindo à documentação completa do sistema Imobiliária Bortone. Este portal concentra todas as informações técnicas, guias de desenvolvimento e padrões do projeto.
Projeto Acadêmico - Desenvolvido pelas turmas da FATEC Registro para o Laboratório de Práticas 2025-2.
🚀 Início Rápido
Para Desenvolvedores
- 🏗️ Arquitetura e Infraestrutura - ⭐ Visão completa da arquitetura (Render + Vercel + Cloudinary)
- 📋 Regras Gerais do Repositório - Fluxo de desenvolvimento, branches, commits e PRs
- 🏗️ Estrutura de Pastas - Organização do projeto e arquitetura
- 🔧 WebSocket Setup - Configuração do sistema de chat em tempo real
Para Administradores
- 👥 Sistema de Níveis de Usuário - Gerenciamento de permissões no chat
- 🐛 Relatório de Correção de Bugs - Histórico de correções do sistema de chat
📚 Documentação por Área
🎨 Frontend (Next.js)
Documentação completa do frontend em Next.js, incluindo configurações, componentes e boas práticas.
- Configurações do Next.js - Setup e configuração do framework
- 📦 Componentização - ⭐ Arquitetura de componentes e padrões de desenvolvimento
- Manual de Tags - Convenções de marcação e componentes
- Middleware de Indexação - Sistema de middleware personalizado
🔧 Backend & APIs
Documentação técnica das APIs, serviços e funcionalidades do servidor.
Core APIs
- API de Imóveis - Endpoints para gestão de propriedades
- API de Imagens - ⚡ Sistema Cloudinary - Upload e gerenciamento
- API de FAQ - Endpoints do sistema de perguntas frequentes
- FAQ - Gerenciamento CMS - CRUD de FAQs no painel administrativo
- Dashboard - Métricas e relatórios administrativos
- Banco de Dados - Estrutura e relacionamentos
Sistema de Imagens
Documentação completa da migração para Cloudinary e nova arquitetura.
- 📋 Resumo da Migração - ⭐ Migração Cloudinary Completa
- 🏗️ Arquitetura Cloudinary - Fluxo técnico detalhado
- ⚠️ Análise de Problemas - Histórico de issues resolvidas
Sistema de Mapa
Funcionalidades geográficas e de localização integradas ao Google Maps.
- API de Mapa - Documentação completa das rotas
- Implementação da API - Detalhes técnicos de implementação
- Resumo da Integração - Visão geral e casos de uso
Sistema de Chat & Suporte
- Chat de Suporte - Documentação do sistema de atendimento
- WebSocket em Produção - Deploy e configuração para produção
Algoritmos Inteligentes
- Algoritmo de Recomendação - Sistema de sugestões personalizadas baseado em ML
🛠️ Configuração do Ambiente
Executar a Documentação Localmente
-
Instalar dependências do MkDocs:
pip install mkdocs mkdocs-material -
Navegar para a pasta de documentação:
cd documentacao/ -
Executar o servidor local:
mkdocs serve -
Acessar no navegador:
http://127.0.0.1:8000
Estrutura da Documentação
documentacao/
├── docs/ # Arquivos Markdown
│ ├── api/ # Documentação das APIs
│ ├── frontend/ # Documentação do frontend
│ ├── assets/ # Recursos estáticos (imagens, ícones)
│ └── stylesheets/ # Estilos customizados
├── mkdocs.yml # Configuração da navegação
└── README.md # Guia inicial
🤝 Contribuindo
Encontrou algo desatualizado ou quer contribuir com a documentação?
- Siga as Regras Gerais do repositório
- Abra uma issue descrevendo o problema ou melhoria
- Crie um Pull Request com suas alterações
- Aguarde a revisão da equipe
📋 Status da Documentação
| Seção | Status | Última Atualização |
|---|---|---|
| Regras Gerais | ✅ Completo | Set 2025 |
| APIs Backend | ✅ Completo | Set 2025 |
| Frontend Next.js | ✅ Completo | Set 2025 |
| Sistema de Chat | ✅ Completo | Set 2025 |
| Mapa/Geolocalização | ✅ Completo | Set 2025 |
| Algoritmos ML | ✅ Completo | Set 2025 |
Para dúvidas específicas, consulte a documentação correspondente ou abra uma issue no repositório.