2.0.0 • Published 5 months ago

kickable

Licence

ISC

Version

2.0.0

Deps

Size

22 kB

Vulns

Weekly

kickable is a microservice built to answer the age old question, "Can I Kick It?"

Currently only the word "it" is kickable.

NPM	Build	Coverage	Vulnerabilities

Requirements

Node.js 22+

$ npm ci
$ npm run build
$ npm start

The service listens on port 3000 by default. Set the PORT environment variable to override:

$ PORT=8080 npm start

$ npm run typecheck

$ npm run lint

$ npm run build

$ npm test

$ npm run test:coverage

Returns 200 OK. Used by load balancers and orchestrators to verify liveness.

Returns true if :it is kickable, otherwise false.

Example:

$ curl http://localhost:3000/kick/it
true

$ curl http://localhost:3000/kick/sky
false

Case insensitivity
Support for configuring kickable items other than it
Return true if the item is a known kickable noun (ball, wall, door); otherwise false (sky, feelings, comments)

Hector Gray (Twitter: @defstream)

Pull Requests welcome. Please make sure all checks pass:

$ npm run typecheck
$ npm run lint
$ npm test

Please submit Github issues for any feature enhancements, bugs or documentation problems.

MIT