🍛 🍴 a jshttp based µframework 🍴 🍝
Switch branches/tags
Clone or download
Latest commit 0f95e6f Nov 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin get rid of all the rest of the knork references Feb 6, 2018
db expose ormnomnom decorators Feb 8, 2018
decorators add decorators/compose Aug 5, 2018
docs Removed Note section regarding cryptiles dep Aug 16, 2018
examples/html-with-nunjucks get rid of all the rest of the knork references Feb 6, 2018
lib fix: typo (#97) Sep 26, 2018
middleware fix: response metrics are counts, not gauges (#107) Nov 16, 2018
presentations add seattlejs presentation Jan 12, 2018
scaffold get rid of all the rest of the knork references Feb 6, 2018
templates wip: add template context serializer Oct 6, 2017
test fix linter INFRACTION Aug 5, 2018
utils do not apply stall check in test mode Aug 6, 2018
views fix: we were pulling in the wrong joi (#3) Jul 28, 2016
.gitignore ignore coverage/ Dec 29, 2016
.npmignore fixup npmignore May 15, 2018
.remarkrc add remark-slug Jan 23, 2016
.travis.yml it is now spife o'clock Jan 11, 2018
CHANGELOG.md chore(release): 12.2.4 Nov 16, 2018
LICENSE add LICENSE Apr 26, 2017
README.md change badge Jan 11, 2018
commands.js place commands at "@npm/knork/commands" for external consumption Jul 25, 2017
joi.js initial code commit Jan 16, 2016
logging.js BREAKING: rework logging Apr 26, 2017
package-lock.json 12.2.5 Nov 19, 2018
package.json 12.2.5 Nov 19, 2018
reply.js fully port "http" to "reply" Jan 19, 2016
routing.js initial code commit Jan 16, 2016
spife.js lint fixes May 15, 2018

README.md

🍴 Spife 🍴

Build Status Greenkeeper badge

Welcome to Spife! It cuts like a knife, but scoops like a spoon!

Spife is a jshttp-based microframework with Opinions (TM). Collects and curates the following packages:

  1. Routing, courtesy of reverse,
  2. Database access, courtesy of pg
  3. Per-request concurrency and transactions, courtesy of pg-db-session,
  4. An ORM, courtesy of ormnomnom,
  5. Metrics gathering, courtesy of numbat-emitter,
  6. Monitoring, a la restify-monitor,
  7. and Logging, courtesy of bole

API

Full docs are available here.

  1. If you're just getting started with Spife, you might try the tutorial!
  2. You might have some questions. Check the FAQ.
  3. The topic documentation lays out the high-level concepts.
  4. Reference documentation covers API signatures and methods.

📦 denotes a link to an external package that has been bundled with Spife.

Development

To develop locally, clone this repository, and run npm install in a shell in the repository directory. From there you can:

  • npm test: Run both the linter and the code tests.
  • npm run lint: Run just the linter.
  • npm run cov:test: Run the code tests with code coverage enabled.
  • npm run cov:html: Run the code tests and output a coverage directory. serve the directory at http://localhost:60888.

License

ISC