Pular para o conteúdo principal

Onboarding — novo desenvolvedor

Objetivo: no primeiro dia, rodar o front, entender as duas APIs e achar a pasta certa.

Dia 0 — acesso

  • Repo GitHub Gevtech/ARKUS_FRONTEND
  • Conta de QA na API Central (não use produção)
  • Leitura de SECURITY.md e LICENSE
  • Node 20 + npm ci

Dia 1 — subir

Siga setup.md. Checklist:

  • npm run dev abre o login
  • Login com user de QA
  • Painel lista pelo menos uma empresa (ou explica o vazio pelo Network)
  • npm run test e npm run lint passam

O que ler (nessa ordem)

  1. README.md — 10 min
  2. architecture.md + c4
  3. api/README.md — por que dois hosts
  4. Grupo da sua área em .cursor/docs/README.md
  5. CONTRIBUTING.md antes do primeiro PR

Se for governança: doc.md, doc-criar-usuario.md, doc-permissao-por-role.md.
Se for tema: doc-dark-mode.md.
Se for MCC/taxas: doc-empresa-mcc-parametrizacao.md.

Mapa mental de pastas

Quero…Vou em…
Página / rotasrc/views ou src/directories/views + ROUTES
HTTPsrc/models/services/<área>
Tipo DTOsrc/models/types
Mapper purosrc/domain
Bloco de White Labelsrc/directories/blocks/<aba>
Doc de API na UIsrc/integrationApiDocs
String visívelsrc/locales/*

Primeiro PR pequeno

Sugestões: teste em service existente, i18n faltando, doc. Evite no dia 1: cadastro de empresa, permissões, session vault.

Contatos

Tech lead da área (CODEOWNERS). Segurança: canal em SECURITY.md, não Slack aberto com JWT.