@whook/example

A basic Whook server

This is a basic Whook server demonstrating the various usages of the Whook framework to build REST APIs.

Usage

To run the server in production:

# For the first time create a strong JWT secret
echo 'JWT_SECRET=$(openssl rand -base64 10)' > .env.app.production
# And install the dependencies
npm i

# Then and later, just run build and run the server
npm run build

NODE_ENV=production APP_ENV=production node --run start

You can understand deeply this repository and Whook's internal by simply reading the Architecture Notes. The "See in context" links drive your directly in the concerned implementation so that you can just see the code that explains the notes.

Feel free to continue creating architecture notes and to regenerate the markdown file by running:

node --run architecture

Dev

Start the server in development:

# Simple dev mode
node --run dev

# Watch mode
node --run watch

Run and update tests:

# Run the tests
npm t

# Updating tests snapshots
node --run jest -- -u

Create a new route / cron / service / provider or command:

node --run create

Play with the REPL:

node --run repl

Generate the dependency injection graph (here, for the putTime handler):

node --run whook -- __inject putTime,mermaid > DEPENDENCIES.mmd;
docker run --rm -u `id -u`:`id -g` -v $(pwd):/data minlag/mermaid-cli -i DEPENDENCIES.mmd -o DEPENDENCIES.mmd.svg;

List available commands:

## In dev mode
node --run dev -- ls
## With built files
npx whook ls

Generate API types:

node --run apitypes

Debug

Execute a route handler in isolation:

node --run dev -- route --name putEcho --parameters '{"body": { "echo": "YOLO!" }}'

Execute a cron handler in isolation:

node --run dev -- cronRun --name handleMinutes --date '2025-03-15T17:00:00Z'

Debug whook internals:

DEBUG=whook node --run dev

Debug knifecycle internals (dependency injection issues):

DEBUG=knifecycle node --run dev

Authors

• Nicolas Froidure

License

MIT