Home

HireFlow — Documentação

Bem-vindo à documentação oficial do HireFlow. Este diretório contém tudo que você precisa para entender o projeto — desde a visão geral até os detalhes técnicos de implementação.

Nota: Esta documentação é um documento vivo. Seções marcadas com 🚧 Em construção correspondem a funcionalidades ainda não implementadas e serão atualizadas conforme o projeto avança.

---

Índice

#	Documento	Descrição
01	Introdução	O que é o HireFlow, o problema que resolve e quem o utiliza
02	Arquitetura	Visão geral técnica, ecossistemas separados e fluxo de comunicação
03	Banco de Dados	Modelagem, tabelas, relacionamentos e decisões de design
04	Autenticação	Fluxo de auth, Sanctum, OAuth LinkedIn e proteção de rotas
05	Roles & Permissões	Papéis de usuário, matriz de permissões e como são verificadas
06	Pipeline de Vagas	Como funciona o pipeline de seleção, etapas e auditoria
07	Convenções da API	Padrões REST, formato de resposta, erros e versionamento
08	Setup de Desenvolvimento	Como rodar o projeto localmente do zero
09	Padrões de Código	Convenções de código, commits, idioma e estrutura de pastas
10	Glossário	Termos técnicos e de domínio utilizados no projeto
11	Personas	Quem são os usuários, seus objetivos e dores
12	Casos de Uso	Fluxos completos narrados de ponta a ponta

---

Visão rápida do projeto

HireFlow é um ATS (Applicant Tracking System) fullstack com portal público para candidatos e painel interno para equipes de RH.

hireflow-api/   → API REST em Laravel
hireflow-web/   → Frontend em Next.js

Para começar a rodar o projeto localmente, veja Setup de Desenvolvimento.
Para entender o que o sistema faz, comece pela Introdução.

---

Status do projeto

Bloco	Status
Infraestrutura	✅ Concluído
API (Laravel)	🔄 Em andamento
Frontend (Next.js)	🚧 Não iniciado
Documentação	🔄 Em andamento
DevOps / CI-CD	🚧 Não iniciado