Ir para o conteúdo

Instalação

Requisitos

  • Node.js >= 20
  • TypeScript >= 5.7 (recomendado)

Instalar

npm install tempest-express-sdk tempest-db-js express zod

Peer dependencies

tempest-db-js é uma peer dependency obrigatória (camada de banco). Para autenticação, instale também as peers opcionais:

npm install bcryptjs jsonwebtoken

Sem elas o SDK importa normalmente — o erro só aparece quando você instancia PasswordUtils / JWTUtils.

Criar um projeto do zero

O CLI gera um serviço Express completo, em camadas, já com Swagger + Redoc:

npx tempest-express new meu-servico
cd meu-servico
npm install
cp .env.example .env
npm run dev

Comandos do CLI

Comando O que faz
tempest-express new <nome> Cria um serviço completo
tempest-express generate <Nome> Gera um recurso CRUD (model→router)
tempest-express secret [--bytes 32] Gera um segredo aleatório (JWT/token)
tempest-express docker-compose Escreve um docker-compose.yml (Postgres + Redis)
tempest-express db Orientação sobre migrations (via tempest-db-js)
tempest-express lint [--dir .] Roda o Biome check no projeto
tempest-express config [--dir .] Imprime os settings base resolvidos (lê .env)
tempest-express user --email <e> --password <p> [--admin] Imprime um registro de usuário pronto pra inserir (hash bcrypt)

tsconfig recomendado

O SDK e o template usam alias @ apontando para src e sem sufixo .js:

{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "Bundler",
    "strict": true,
    "paths": { "@/*": ["./src/*"] }
  }
}