Skip to main content
Version: Next

Overview

info

Servable is still experimental and its api may change in the future.

logo

Servable is a Node JS framework built for protocols running on your framework engine of choice. It provides a concise, easy to use and scalable template to get the best of protocols.

The Servable framework at its core is a server template that uses the @servable/server to launch the different protocols applied to models and executed on the framework engine. It does not handle any database nor does it expose any API by itself. Instead it relies on a Framework engine that conforms to a set of APIs defined by Servable (Object, Query, Auth, ...).

Main protocols:

  • Quick start and Plug & Play Node JS framework
  • Tailored for protocols
  • Community protocols
  • Schema based models and auto-migration
  • Highly extensible

Servable documentation​

This is the official documentation site for Servable. Content on this site is sourced in GitHub. For more information, see Contributing to Servable documentation.

This site is based on Docusaurus.

We use the Diátaxis documentation authoring framework which organizes technical documentation into a system based on four quadrants:

  • Learning-oriented Tutorials provide hands-on lessons where users can learn the framework by doing.

  • Problem-oriented How-to Guides provide recipes to solve specific goals you may encounter while building a LoopBack project.

  • Understanding-oriented Concepts pages provide the explanation of architecture concepts, wider view and deeper knowledge about the framework.

  • Information-oriented Reference guides provide technical description of the machinery and how to use it.