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 devabre o login - Login com user de QA
- Painel lista pelo menos uma empresa (ou explica o vazio pelo Network)
-
npm run testenpm run lintpassam
O que ler (nessa ordem)
- README.md — 10 min
- architecture.md + c4
- api/README.md — por que dois hosts
- Grupo da sua área em
.cursor/docs/README.md - 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 / rota | src/views ou src/directories/views + ROUTES |
| HTTP | src/models/services/<área> |
| Tipo DTO | src/models/types |
| Mapper puro | src/domain |
| Bloco de White Label | src/directories/blocks/<aba> |
| Doc de API na UI | src/integrationApiDocs |
| String visível | src/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.