Documentação técnica

Documentação

Guias completos, referência de API e tutoriais para desenvolver e integrar com a plataforma.

Seções

Início Rápido

1
Clone o repositório
git clone https://github.com/estevam5s/pedacinho-scrum.git
2
Instale as dependências
cd pedacinho-scrum && npm install
3
Configure as variáveis de ambiente
cp .env.example .env.local # Edite o .env.local com suas credenciais
4
Inicie o servidor de desenvolvimento
npm run dev # Acesse http://localhost:3000

Variáveis de Ambiente

VariávelDescriçãoObrigatório
NEXT_PUBLIC_SUPABASE_URLURL do projeto Supabase principal Sim
NEXT_PUBLIC_SUPABASE_ANON_KEYChave anônima do Supabase Sim
NEXT_PUBLIC_CONSUMO_SUPABASE_URLURL do Supabase de consumo Sim
NEXT_PUBLIC_CONSUMO_SUPABASE_ANON_KEYChave do Supabase de consumo Sim
GROK_API_KEYAPI key do Grok AI (xAI)Opcional
SMTP_HOSTHost do servidor SMTP para e-mailsOpcional
SMTP_PORTPorta SMTP (geralmente 587)Opcional
SMTP_USERUsuário do SMTPOpcional
SMTP_PASSSenha de app do SMTPOpcional

Módulos

Dashboard
Board Scrum
Financeiro
Funcionários
Consumo
BI
IA
Notificações

API Reference

/api/projects
/api/tasks
/api/financeiro
/api/funcionarios
/api/consumo
/api/bi
/api/ai

Banco de Dados

Schema Supabase
Tabelas principais
Views e Functions
Row Level Security

Autenticação

Supabase Auth
OAuth Google
Sessões e tokens
Proteção de rotas

Deploy

Vercel (recomendado)
Variáveis de ambiente
Domínio customizado
Monitoramento

Documentação completa na plataforma

A documentação interativa com gráficos, modelo de dados e design system está disponível dentro da plataforma após o login.

Acessar a plataforma