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

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.

• Modules
  • require('@npm/spife') → createServer
  • Middleware
    • 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
    • 📦 require('@npm/spife/routing') → reverse
    • require('@npm/spife/reply')
    • Incoming Requests
  • Database
    • 📦 require('@npm/spife/db/session') → pg-db-session
    • 📦 require('@npm/spife/db/connection') → pg
    • 📦 require('@npm/spife/db/orm') → ormnomnom
  • Sub-packages
    • 📦 require('@npm/spife/logging') → bole
    • 📦 require('@npm/spife/joi') → joi
  • Common Decorators
    • require('@npm/spife/decorators/transaction')
    • require('@npm/spife/decorators/validate')
  • Common Views
    • require('@npm/spife/views/paginate')
  • Utilities
    • require('@npm/spife/utils/paginate')
    • require('@npm/spife/utils/rethrow')

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.

ISC