Initial commit DBMaker - Oficiais e Funcionando
This commit is contained in:
98
DOCUMENTACAO.md
Normal file
98
DOCUMENTACAO.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# SteelBook - Documentação
|
||||
|
||||
## 📋 Visão Geral
|
||||
|
||||
SteelBook é uma aplicação web para gestão inteligente de databooks, permitindo criar, editar e gerenciar documentos estruturados com templates customizáveis.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
```bash
|
||||
# Instalar dependências
|
||||
npm install
|
||||
|
||||
# Desenvolvimento
|
||||
npm run dev
|
||||
|
||||
# Build para produção
|
||||
npm run build
|
||||
|
||||
# Preview do build
|
||||
npm preview
|
||||
```
|
||||
|
||||
## 📁 Estrutura do Projeto
|
||||
|
||||
```
|
||||
src/
|
||||
├── components/ # Componentes React reutilizáveis
|
||||
├── pages/ # Páginas da aplicação
|
||||
├── lib/ # Utilitários e configurações
|
||||
├── contexts/ # Context API
|
||||
├── hooks/ # Custom hooks
|
||||
├── types/ # Tipos TypeScript
|
||||
└── main.tsx # Entrada da aplicação
|
||||
|
||||
docs/
|
||||
├── auxiliar/ # Documentação auxiliar e notas de desenvolvimento
|
||||
└── ...
|
||||
```
|
||||
|
||||
## 🔧 Configuração
|
||||
|
||||
### Variáveis de Ambiente
|
||||
|
||||
Crie um arquivo `.env` na raiz do projeto:
|
||||
|
||||
```env
|
||||
VITE_SUPABASE_URL=sua_url_supabase
|
||||
VITE_SUPABASE_ANON_KEY=sua_chave_anonima
|
||||
SUPABASE_SERVICE_ROLE_KEY=sua_chave_service_role
|
||||
```
|
||||
|
||||
## 📦 Dependências Principais
|
||||
|
||||
- **React 18** - Framework UI
|
||||
- **Vite** - Build tool
|
||||
- **TypeScript** - Type safety
|
||||
- **Tailwind CSS** - Styling
|
||||
- **Supabase** - Backend
|
||||
- **React Query** - Data fetching
|
||||
- **React Router** - Routing
|
||||
- **Zustand** - State management
|
||||
|
||||
## 🎯 Funcionalidades
|
||||
|
||||
- ✅ Gestão de Templates
|
||||
- ✅ Gestão de Tópicos
|
||||
- ✅ Criação de Databooks
|
||||
- ✅ Design customizável
|
||||
- ✅ Dark mode
|
||||
- ✅ Busca avançada
|
||||
- ✅ Geração de PDF
|
||||
|
||||
## 🚀 Otimizações Implementadas
|
||||
|
||||
- Code splitting com lazy loading
|
||||
- Chunk optimization no Vite
|
||||
- React Query caching
|
||||
- CSS otimizado
|
||||
- Tree shaking automático
|
||||
|
||||
## 📚 Documentação Auxiliar
|
||||
|
||||
Veja a pasta `docs/auxiliar/` para documentação detalhada sobre:
|
||||
- Implementação de Dark Mode
|
||||
- Setup de Design
|
||||
- Ajustes de Preview
|
||||
- E muito mais...
|
||||
|
||||
## 🤝 Contribuindo
|
||||
|
||||
1. Crie uma branch para sua feature
|
||||
2. Commit suas mudanças
|
||||
3. Push para a branch
|
||||
4. Abra um Pull Request
|
||||
|
||||
## 📄 Licença
|
||||
|
||||
Veja o arquivo LICENSE para detalhes.
|
||||
Reference in New Issue
Block a user