Skip to content

Getting Started

Jump to bottom
nbsjunior edited this page Aug 11, 2026 · 2 revisions

Briefing para CTO / líder técnico: comece por Posicionamento-e-metricas e o Home.

Getting Started

Pré-requisitos

  • Node.js 22+ (o repo usa type-stripping nativo — arquivos .ts rodam direto com node, sem build, exceto onde indicado)
  • Java (apenas para o emulador do Firestore, se for rodar o backend localmente)
  • Firebase CLI: npm install -g firebase-tools

Clonar e instalar

git clone https://github.com/nbsjunior/codehero.git
cd codehero
npm install

Isso instala as dependências de todos os workspaces (packages/*, apps/functions, apps/web) de uma vez — é um monorepo com npm workspaces.

Build dos contratos

@codehero/contracts é a dependência compartilhada (tipos SARIF, catálogo de regras, SDD Spec, fórmulas SQALE, matcher). Scanner, Functions, MCP e Ruleforge dependem do seu dist/:

npm run build:contracts

Rode isso sempre que editar algo em packages/contracts/src/.

Primeira execução — escanear o exemplo

node packages/scanner/src/index.ts examples/

Saída esperada: uma lista de findings (BLOCKER/CRITICAL/MAJOR/MINOR/INFO) no arquivo examples/vulnerable_sample.py, seguida do resumo de débito técnico. Se isso funcionar, o setup está correto.

Próximo passo: Running the Scanner para entender as flags e o formato SARIF, ou Firebase Backend para subir o backend completo localmente.

Clone this wiki locally