joint-kit v0.0.33
Joint Kit
A server-side toolset for building authorized data layers and RESTful endpoints with NodeJS.
Joint Kit solutions are configuration-driven. Use a JSON-based syntax to rapidly implement operation logic on top of your data schema.
Designed to be flexible. Mix it with existing code (programmatically) -or- use it to dynamically generate an entire server-side method library and RESTful API router with minimal programming.
WIP
Not ready for public use until version 0.1.0 - Syntax and logic are in frequent flux.
Table of Contents
Prerequisites
To use the Joint Kit, you need:
- a supported persistence solution (e.g. Postgres)
- a configured data schema (e.g. database & tables)
- a supported service interface / ORM
The Joint Kit currently supports:
| Service | Required Plugins | Persistence Options |
|---|---|---|
| Bookshelf | registry, pagination | Postgres, MySQL, SQLite3 |
---
If you want to generate a RESTful API, you need:
- a supported server framework
The Joint Kit currently supports:
| Server | Required Middleware |
|---|---|
| Express | body-parser, cookie-parser |
How to Use
Install
$ yarn add joint-kitFor Developers
Dev Lint
The app uses ESLint for source code linting (specifically, the standard style). The linting will run automatically on git commit.
$ yarn lintYou can run with flag
--fix, or shortcut command flint, to trigger auto fixing (e.g.yarn flint).
Dev Test
The app uses Mocha for the unit testing framework, and Chai for its assertions.
Run Unit Tests
$ yarn test:unitRun Functional Tests
$ yarn test:functionalRun All Tests (Unit + Functional)
$ yarn test