/ferry

Ferry is (yet another) REST API framework.

Primary LanguageJavaScript

Ferry

wercker status

Ferry is (yet another) REST API framework.

Usage

Typically, Ferry is required as a dependency when creating a server implementation. See example implementations.

Engines

Engines power Ferry; they are third-party modules that provide various features. In order to create a functional API, one engine of each type is required.

Adapters are Ferry modules that provide the interface between an engine and the Ferry framework.

Router

Specification

Storage

Contributing

Development

An easy way to work on the Ferry suite of packages is to clone all of the desired repositories into a top-level ferryjs directory, and then use the symlink package to automatically npm link the local repositories.

  • npm install -g symlink (at least v1.0.0)
  • cd ferryjs
  • git clone https://github.com/ferryjs/ferry.git (do this for all ferry repositories)
  • git clone https://github.com/ferryjs/ferry-examples.git
  • symlink ./ ferry-examples/ (and include any other directories that contain ferry projects)

If the symlink and/or npm link steps error out, just re-run them.