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óriogit clone https://github.com/estevam5s/pedacinho-scrum.git
2
Instale as dependênciascd pedacinho-scrum && npm install
3
Configure as variáveis de ambientecp .env.example .env.local
# Edite o .env.local com suas credenciais
4
Inicie o servidor de desenvolvimentonpm run dev
# Acesse http://localhost:3000
Variáveis de Ambiente
| Variável | Descrição | Obrigatório |
|---|---|---|
| NEXT_PUBLIC_SUPABASE_URL | URL do projeto Supabase principal | Sim |
| NEXT_PUBLIC_SUPABASE_ANON_KEY | Chave anônima do Supabase | Sim |
| NEXT_PUBLIC_CONSUMO_SUPABASE_URL | URL do Supabase de consumo | Sim |
| NEXT_PUBLIC_CONSUMO_SUPABASE_ANON_KEY | Chave do Supabase de consumo | Sim |
| GROK_API_KEY | API key do Grok AI (xAI) | Opcional |
| SMTP_HOST | Host do servidor SMTP para e-mails | Opcional |
| SMTP_PORT | Porta SMTP (geralmente 587) | Opcional |
| SMTP_USER | Usuário do SMTP | Opcional |
| SMTP_PASS | Senha de app do SMTP | Opcional |
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