# :fork_and_knife: Spife :fork_and_knife:

[![Build Status](https://travis-ci.org/npm/spife.svg?branch=master)](https://travis-ci.com/npm/spife)
[![Greenkeeper badge](https://badges.greenkeeper.io/npm/spife.svg?token=0594e62a6db02b36ab9a5dafe3982cc253ca070119b560a3e798ab0950643d2b&ts=1493750747725)](https://greenkeeper.io/)

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

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

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

## API

Full docs [are available here][docs].

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

-------------------------------------

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

* Modules
  * [`require('@npm/spife') → createServer`][ref-server]
  * **[Middleware][topic-request-lifecycle]**
    * `require('@npm/spife/middleware/transaction') → TransactionMiddleware`
    * `require('@npm/spife/middleware/database') → DatabaseMiddleware`
    * `require('@npm/spife/middleware/monitor') → MonitorMiddleware`
    * `require('@npm/spife/middleware/metrics') → MetricsMiddleware`
    * `require('@npm/spife/middleware/logging') → LoggingMiddleware`
    * `require('@npm/spife/middleware/common') → CommonMiddleware`
  * **HTTP**
    * :package: [`require('@npm/spife/routing') → reverse`][reverse]
    * [`require('@npm/spife/reply')`][ref-reply]
    * [Incoming Requests][ref-request]
  * **Database**
    * :package: [`require('@npm/spife/db/session') → pg-db-session`][pg-db-session]
    * :package: [`require('@npm/spife/db/connection') → pg`][pg]
    * :package: [`require('@npm/spife/db/orm') → ormnomnom`][ormnomnom]
  * **Sub-packages**
    * :package: [`require('@npm/spife/logging') → bole`][bole]
    * :package: [`require('@npm/spife/joi') → joi`][joi]
  * **Common Decorators**
    * [`require('@npm/spife/decorators/transaction')`][ref-transaction]
    * [`require('@npm/spife/decorators/validate')`][ref-validate]
  * **Common Views**
    * [`require('@npm/spife/views/paginate')`][ref-view-paginate]
  * **Utilities**
    * [`require('@npm/spife/utils/paginate')`][ref-paginate]
    * [`require('@npm/spife/utils/rethrow')`][ref-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

[bole]: https://github.com/rvagg/bole
[docs]: ./docs
[getting-started]: ./docs/getting-started.md
[faq]: ./docs/faq.md
[topics]: ./docs/topics
[reference]: ./docs/reference
[joi]: https://github.com/hapijs/joi
[numbat-emitter]: https://github.com/ceejbot/numbat-emitter
[ormnomnom]: https://github.com/chrisdickinson/ormnomnom
[pg-db-session]: https://github.com/npm/pg-db-session
[pg]: https://github.com/brianc/node-postgres
[ref-paginate]: ./docs/reference/utils-paginate.md
[ref-reply]: ./docs/reference/reply.md
[ref-request]: ./docs/reference/request.md
[ref-rethrow]: ./docs/reference/utils-rethrow.md
[ref-server]: ./docs/reference/server.md
[ref-transaction]: ./docs/reference/decorator-transaction.md
[ref-validate]: ./docs/reference/decorator-validate.md
[ref-view-paginate]: ./docs/reference/view-paginate.md
[restify-monitor]: https://www.npmjs.com/package/@ceejbot/restify-monitor
[reverse]: https://github.com/chrisdickinson/reverse
[topic-ethos]: ./docs/topics/ethos.md
[topic-request-lifecycle]: ./docs/topics/request-lifecycle.md