src/site concentra a experiência pública, src/plataforma concentra as jornadas FortCard, src/shared reúne contratos e elementos reutilizáveis, src/aplicacao faz a composição e src/rotas mantém o contrato de navegação.
Como usar esta documentação
Ao executarnpm run dev, o projeto abre duas abas no navegador:
- aplicação local, com as telas navegáveis;
- documentação Mintlify, com o handoff técnico.
Visão rápida: novo parceiro white label
Quando um novo parceiro ou lojista contratar a solução, o fluxo esperado é:- O parceiro informa domínio ou subdomínio, marca, cores, favicon, banners e produtos que deseja oferecer.
- A FortCard configura essa origem pública no ambiente de publicação.
- O domínio ou subdomínio do parceiro aponta para o ambiente definido pela FortCard.
- Ao acessar esse endereço, o Site identifica o host público e carrega a configuração visual correspondente.
- O front mostra somente a marca, banners e produtos permitidos para aquela origem.
- Quando a pessoa inicia uma simulação, o front envia o contexto público da origem e o produto escolhido para o backend.
- O backend revalida o host, confirma o parceiro e resolve os dados operacionais FortCard antes de criar ou avançar uma proposta.
Leitura rápida
- Índice da documentação: mapa dos módulos, páginas e caminhos de leitura por objetivo.
- Rodar o projeto: instalação, porta local, build e comandos principais.
- Estrutura e rotas: diretórios, superfícies e slugs.
- Visão geral da arquitetura: superfícies, responsabilidades e limites.
- Entrada e identificação do parceiro: domínio, subdomínio, tenant público e validação no backend.
- Modelos de adoção: publicação do Site e da plataforma sem quebrar o contrato público.
- Site público e produtos: página inicial, páginas de produto, institucionais, IDs públicos e CTAs.
- Fluxos de Empréstimos: diagramas, rotas e pontos de integração das jornadas.
- Integrar backend: substituição de dados demonstrativos por adaptadores reais.
- Contratos do backend da aplicação: exemplos de endpoints próprios esperados pelo front.
- White label: troca de logos, cores e banners do Site e das páginas de produto.
Escopo
A entrega contém:- página inicial;
- páginas de produto para empréstimo pessoal, consignado CLT e antecipação salarial;
- termos, privacidade e contato;
- fluxo de empréstimo pessoal;
- fluxo de consignado CLT;
- fluxo de antecipação salarial;
- Área Logada;
- tema FortCard em Material UI;
- componentes compartilhados;
- dados demonstrativos documentados;
- otimização de banners públicos.
Fora do escopo
Não fazem parte da entrega:- backend;
- autenticação real;
- API de crédito;
- painel administrativo;
- CMS;
- integração bancária real.
Superfícies entregues
Fonte de verdade
- Rotas:
src/rotas/routes.json. - Tema:
src/shared/tema/fortTokens.tsesrc/shared/tema/fortTheme.ts. - Marca pública:
src/shared/marca/tenantConfig.ts. - Banners públicos:
src/site/banner-assets.json. - Dados demonstrativos removíveis:
src/shared/dados/mock-boundary.json.
Arquitetura de runtime
O Site público usa o domínio ou subdomínio observado para obter uma configuração pública de tenant. Essa configuração pode definir a marca FORT exibida, a origem comercial, os banners e os produtos habilitados. Ela não concede acesso operacional e não contém credenciais. Os Fluxos de Empréstimos e a Área Logada permanecem FortCard. Ao sair de uma página pública para uma jornada, o front envia somente o contexto comercial público e o produto escolhido. O backend valida novamente o host em uma allowlist, resolve os dados operacionais FortCard e decide o que pode seguir para a proposta. Consulte entrada e identificação do parceiro antes de conectar um novo domínio ou parceiro.Caminho recomendado
- Rode
npm cienpm run devna raiz do projeto. - Abra a aba da aplicação para navegar pelas telas.
- Abra a aba do Mintlify para consultar a documentação técnica.
- Leia estrutura e rotas.
- Consulte modelos de adoção para escolher o arranjo adequado.
- Use entrada e identificação do parceiro para configurar o contrato público de origem.
- Use contratos do backend da aplicação para mapear os endpoints próprios necessários.
- Use mapa de dados e dados demonstrativos e autofill para identificar o que sai de mock e o que entra por API.
- Se houver novo cliente, siga logos, cores e banners.
- Antes de publicar uma alteração, rode
npm run quality.