# 🚀 Comece Aqui - SteelBook Bem-vindo ao SteelBook! Este arquivo ajudará você a começar rapidamente. ## 👤 Qual é o seu perfil? ### 👨‍💼 Sou um Usuário Final Você quer usar o SteelBook para criar e gerenciar databooks. **Próximos passos:** 1. Leia [Manual do Usuário](docs/MANUAL_USUARIO.md) 2. Comece com [Primeiros Passos](docs/MANUAL_USUARIO.md#primeiros-passos) 3. Crie seu [Primeiro Databook](docs/MANUAL_USUARIO.md#criando-um-databook) **Tempo estimado:** 30 minutos --- ### 👨‍💻 Sou um Desenvolvedor Você quer entender a arquitetura e contribuir com código. **Próximos passos:** 1. Leia [Arquitetura Técnica](docs/ARQUITETURA_TECNICA.md) 2. Estude o [Banco de Dados](docs/ARQUITETURA_TECNICA.md#banco-de-dados) 3. Configure o [Ambiente](docs/ARQUITETURA_TECNICA.md#variáveis-de-ambiente) 4. Clone e instale o projeto **Tempo estimado:** 1 hora --- ### 🏢 Sou um Administrador Você quer configurar e manter o SteelBook. **Próximos passos:** 1. Leia [README Principal](README.md) 2. Configure [Supabase](README.md#configuração-do-supabase) 3. Acesse [Configurações](docs/MANUAL_USUARIO.md#configurações) 4. Gerencie [Usuários](docs/MANUAL_USUARIO.md#3️⃣-gerenciamento-de-usuários) **Tempo estimado:** 1 hora --- ## 📚 Documentação Disponível ### 📘 Para Usuários - **[Manual do Usuário](docs/MANUAL_USUARIO.md)** - Guia completo - Como usar cada funcionalidade - Passo a passo ilustrado - Dicas e truques - Perguntas frequentes ### 🏗️ Para Desenvolvedores - **[Arquitetura Técnica](docs/ARQUITETURA_TECNICA.md)** - Documentação técnica - Estrutura do sistema - Banco de dados (13 tabelas) - Fluxo de dados - Segurança e autenticação ### 📖 Índice Geral - **[Índice de Documentação](docs/README.md)** - Navegação centralizada - Todos os documentos - Índices rápidos - Conceitos principais --- ## 🎯 Tarefas Comuns ### Criar um Databook → [Manual do Usuário - Criando um Databook](docs/MANUAL_USUARIO.md#criando-um-databook) ### Adicionar Documentos → [Manual do Usuário - Gerenciando Documentos](docs/MANUAL_USUARIO.md#gerenciando-documentos) ### Gerar PDF → [Manual do Usuário - Gerando PDF](docs/MANUAL_USUARIO.md#gerando-pdf) ### Configurar Categorias → [Manual do Usuário - Categorias](docs/MANUAL_USUARIO.md#categorias) ### Entender o Progresso → [Manual do Usuário - Progresso](docs/MANUAL_USUARIO.md#entendendo-o-progresso) ### Configurar Banco de Dados → [Arquitetura Técnica - Banco de Dados](docs/ARQUITETURA_TECNICA.md#banco-de-dados) ### Fazer Deploy → [README - Deployment](README.md#deployment) --- ## 🆘 Precisa de Ajuda? ### Encontrei um Erro 1. Verifique [Troubleshooting](docs/ARQUITETURA_TECNICA.md#troubleshooting) 2. Consulte [FAQ](docs/MANUAL_USUARIO.md#perguntas-frequentes) 3. Entre em contato com o suporte ### Não Encontrei o que Procuro 1. Use o [Índice de Documentação](docs/README.md) 2. Procure por palavra-chave 3. Consulte o [Glossário](docs/MANUAL_USUARIO.md#glossário) ### Tenho uma Sugestão 1. Abra uma issue no GitHub 2. Descreva sua sugestão 3. Aguarde feedback --- ## 📱 Acessar Manual no App Dentro do SteelBook: 1. Clique em **Configurações** (menu lateral) 2. Clique na aba **Manual do Usuário** 3. Escolha entre: - Ler online - Download - Navegar por seções - Ver FAQ --- ## 🚀 Instalação Rápida ### Pré-requisitos - Node.js 16+ - npm ou yarn - Conta Supabase ### Passos ```bash # 1. Clone o repositório git clone https://github.com/seu-usuario/steelbook.git cd steelbook # 2. Instale dependências npm install # 3. Configure variáveis de ambiente cp .env.example .env # Edite .env com suas credenciais Supabase # 4. Inicie o servidor npm run dev # 5. Abra no navegador # http://localhost:5173 ``` Veja [README](README.md#quick-start) para detalhes completos. --- ## 📊 Estrutura do Projeto ``` steelbook/ ├── docs/ # Documentação │ ├── README.md # Índice │ ├── MANUAL_USUARIO.md # Para usuários │ └── ARQUITETURA_TECNICA.md # Para devs ├── src/ # Código-fonte ├── supabase/ # Banco de dados ├── README.md # Documentação principal └── COMECE_AQUI.md # Este arquivo ``` --- ## 🎓 Aprendizado Recomendado ### Dia 1: Fundamentos - [ ] Ler [Primeiros Passos](docs/MANUAL_USUARIO.md#primeiros-passos) - [ ] Explorar [Dashboard](docs/MANUAL_USUARIO.md#dashboard) - [ ] Criar primeiro databook ### Dia 2: Funcionalidades - [ ] Adicionar documentos - [ ] Gerenciar tópicos - [ ] Usar categorias ### Dia 3: Avançado - [ ] Configurar pastas - [ ] Personalizar aparência - [ ] Gerar PDF ### Semana 1: Domínio - [ ] Ler [Dicas e Truques](docs/MANUAL_USUARIO.md#dicas-e-truques) - [ ] Explorar todas as configurações - [ ] Dominar o workflow --- ## 💡 Dicas Iniciais 1. **Comece simples** - Crie um databook básico primeiro 2. **Use categorias** - Organize seus tópicos desde o início 3. **Nomeie bem** - Use nomes descritivos para documentos 4. **Revise antes** - Sempre visualize antes de gerar PDF 5. **Explore** - Clique em tudo para aprender --- ## 🔗 Links Importantes | Link | Descrição | |------|-----------| | [Manual do Usuário](docs/MANUAL_USUARIO.md) | Guia completo | | [Arquitetura Técnica](docs/ARQUITETURA_TECNICA.md) | Documentação técnica | | [README](README.md) | Documentação principal | | [GitHub](https://github.com/steelbook) | Código-fonte | | [Supabase](https://supabase.com) | Backend | --- ## 📞 Suporte - **Email:** support@steelbook.dev - **GitHub Issues:** [Abrir issue](https://github.com/steelbook/issues) - **Documentação:** [docs/README.md](docs/README.md) --- ## ✅ Checklist de Início - [ ] Li este arquivo - [ ] Identifiquei meu perfil (usuário/dev/admin) - [ ] Acessei a documentação apropriada - [ ] Instalei/Acessei o SteelBook - [ ] Criei meu primeiro databook - [ ] Explorei as configurações - [ ] Salvei os links importantes --- ## 🎉 Pronto para Começar? Escolha seu caminho: ### 👨‍💼 Usuário [→ Ir para Manual do Usuário](docs/MANUAL_USUARIO.md) ### 👨‍💻 Desenvolvedor [→ Ir para Arquitetura Técnica](docs/ARQUITETURA_TECNICA.md) ### 🏢 Administrador [→ Ir para README Principal](README.md) --- **Bem-vindo ao SteelBook! 🚀** Desenvolvido com ❤️ para profissionais de engenharia. Última atualização: Novembro 2024