Installation¶
Requirements¶
- Node.js >= 20
- TypeScript >= 5.7 (recommended)
Install¶
Peer dependencies
tempest-db-js is a required peer dependency (the database layer).
For authentication, also install the optional peers:
Without them the SDK still imports fine — the error only surfaces when you
instantiate PasswordUtils / JWTUtils.
Start a project from scratch¶
The CLI scaffolds a complete, layered Express service with Swagger + Redoc:
CLI commands¶
| Command | What it does |
|---|---|
tempest-express new <name> |
Create a complete service |
tempest-express generate <Name> |
Scaffold a CRUD resource (model→router) |
tempest-express secret [--bytes 32] |
Generate a random secret (JWT/token) |
tempest-express docker-compose |
Write a docker-compose.yml (Postgres + Redis) |
tempest-express db |
Migration guidance (via tempest-db-js) |
tempest-express lint [--dir .] |
Run the Biome check in a project |
tempest-express config [--dir .] |
Print the resolved base settings (reads .env) |
tempest-express user --email <e> --password <p> [--admin] |
Print a ready-to-insert user record (bcrypt hash) |
Recommended tsconfig¶
The SDK and template use an @ alias pointing at src, with no .js
suffix: