Skip to content

Spool: Generic APIs for easy common 3rd party integrations

License

Notifications You must be signed in to change notification settings

fabrix-app/spool-generics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

spool-generics

Gitter NPM version Build Status Test Coverage Dependency Status Follow @FabrixApp on Twitter

Install

$ npm install @fabrix/spool-generics --save

An adapter protocol for common functions

Generics are common features that web applications need but implement differently. The result of a Generic is a normalized way of handling these different services.

A generic is a great way to implement 3rd parties. You can write your application to implement a single service but easily swap out the the 3rd party.

Generics can add their own Models, Controllers, Services, and Policies so they can support things like vendor specific webhooks or extend functionality of Fabrix.

Current Generics: Email Provider, Payment Processors, Tax Provider, Shipping Provider, Fulfillment, Geolocation, Image Manipulation, HTML rendering, whatever you need!

Can you think of a generic or method we missed? Create a PR!

Usage

Configure

// config/main.js
module.exports = {
  // ...
  spools: [
    require('@fabrix/spool-generics').GenericsSpool
  ]
}