Health checks
System for running simple HTTP health checks.
This knocks out a fairly specific set of criteria though leaves the door open
for extensibility and refactoring. New checks can be added in src/health.ts
.
There is an approach with a fully evented runner system available in the commit history which totally decouples job run time from the runner. Though it was abandoned in favor of simpler.
How to đź’»
- Verify Node.js >= 18 is installed:
node --version
- If something >= 18.x.x is printed, continue
- If not, install Node.js
- I recommend using
fnm
but do whatever works for you
- I recommend using
- Clone project
- Run
npm clean-install
- Run
npm start
- You can also run it directly with
npm run build && node dist/cli.js
- Set
DEBUG=health-check:runner
environment variable for more context, if you'd like
- You can also run it directly with
- Run the tests:
npm test