:fork_and_knife: Knork :fork_and_knife:

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 Knork, 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.

:package: denotes a link to an external package that has been bundled with Knork.

• Modules
  • require('@npm/knork') → createServer
  • Middleware
    • require('@npm/knork/middleware/transaction') → TransactionMiddleware
    • require('@npm/knork/middleware/database') → DatabaseMiddleware
    • require('@npm/knork/middleware/monitor') → MonitorMiddleware
    • require('@npm/knork/middleware/metrics') → MetricsMiddleware
    • require('@npm/knork/middleware/logging') → LoggingMiddleware
    • require('@npm/knork/middleware/common') → CommonMiddleware
  • HTTP
    • :package: require('@npm/knork/routing') → reverse
    • require('@npm/knork/reply')
    • Incoming Requests
  • Database
    • :package: require('@npm/knork/db/session') → pg-db-session
    • :package: require('@npm/knork/db/connection') → pg
    • :package: require('@npm/knork/db/orm') → ormnomnom
  • Sub-packages
    • :package: require('@npm/knork/logging') → bole
    • :package: require('@npm/knork/joi') → joi
  • Common Decorators
    • require('@npm/knork/decorators/transaction')
    • require('@npm/knork/decorators/validate')
  • Common Views
    • require('@npm/knork/views/paginate')
  • Utilities
    • require('@npm/knork/utils/paginate')
    • require('@npm/knork/utils/rethrow')

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