Primeiros Passos

Antes de usar ou desenvolver o PHPB Hub, confirme o modo de execução, o tenant ativo e a origem dos dados carregados pela aplicação.

Requisitos do ambiente

Para rodar a aplicação localmente:

Componente	Requisito
Runtime	Node.js 20+ e npm.
Frontend	React 18, TypeScript, Vite e TanStack Router.
Estado remoto	Não há backend HTTP implementado na versão documentada.
Dados públicos	JSONs sanitizados em public/corpus-samples.json e public/tenants/phpb-sc/corpus-samples.json.
Persistência local	localStorage para projetos, anotações, overrides e estado de ingestão demonstrativa.

Instalação local

Na raiz deste pacote:

npm install
npm run dev

Para executar o tenant de Santa Catarina:

npm run dev:sc

Tenants disponíveis

Comando	Tenant	Efeito
npm run dev	hub	Usa o hub nacional e a rota institucional /phpb.
npm run dev:sc	phpb-sc	Usa o portal estadual, identidade visual própria e rota /phpb-sc.
npm run build:hub	hub	Gera build público do hub nacional.
npm run build:sc	phpb-sc	Gera build público do tenant estadual.

O tenant é resolvido por VITE_PHPB_TENANT; quando a variável não está definida, a aplicação usa hub.

Dados carregados

O carregamento ocorre em src/mocks/corpus-loader.ts.

Fonte	Quando é usada
siteConfig.dataUrl	Caminho principal do JSON do tenant ativo.
src/mocks/data.ts	Fallback quando o JSON público não pode ser carregado.
Overrides no navegador	Correções locais de amostras e documentos aplicadas sobre o payload base.

observação

Os JSONs públicos devem ser sanitizados antes do deploy. Caminhos internos, hashes locais e referências sensíveis não devem aparecer no pacote publicado.

Modo público

Em produção, isPublicDemoMode fica ativo. Nesse modo:

• consulta, análise e download permanecem disponíveis;
• revisão, ingestão, configurações e edição local ficam ocultas ou bloqueadas;
• o usuário não depende de autenticação nem backend;
• alterações operacionais não são persistidas em servidor.

Primeiro uso recomendado

1. Abra Início para conferir métricas e contexto do acervo.
2. Acesse Coleções e filtre por estado, século ou gênero.
3. Abra uma coleção e leia algumas amostras.
4. Use Busca para produzir concordâncias KWIC.
5. Abra Análise para calcular frequências, n-gramas, colocações ou mapas.
6. Crie um Projeto se precisar montar um subcorpus de trabalho.

Próximo passo

Siga para Primeiro Projeto para montar um subcorpus demonstrativo.